askui 0.3.2 → 0.4.0

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

@@ -1,4 +1,5 @@
 import { CustomElementJson } from '../core/model/test-case-dto';
+import { DetectedElement } from '../core/model/annotation-result/detected-element';
 export declare enum Separators {
     STRING = "<|string|>"
 }
@@ -13,7 +14,8 @@ declare abstract class FluentBase {
     protected _textStr: string;
     protected _params: Map<string, unknown>;
     protected static addParams(paramsList: Map<string, unknown[]>, params: Map<string, unknown>): Map<string, unknown[]>;
-    protected commandStringBuilder(currentInstruction?: string, paramsList?: Map<string, unknown[]>): Promise<void>;
+    protected fluentCommandStringBuilder(currentInstruction?: string, paramsList?: Map<string, unknown[]>): Promise<void>;
+    protected getterStringBuilder(currentInstruction?: string, paramsList?: Map<string, unknown[]>): Promise<DetectedElement[]>;
     protected get textStr(): string;
     protected get params(): Map<string, unknown>;
 }
@@ -1558,6 +1560,693 @@ export declare abstract class FluentCommand extends FluentBase {
      * @return {Exec}
      */
     pressAndroidKey(key: ANDROID_KEY): Exec;
-    abstract exec(instruction: string, customElements: CustomElementJson[]): Promise<void>;
+    abstract fluentCommandExecutor(instruction: string, customElements: CustomElementJson[]): Promise<void>;
+}
+export interface ExecutableGetter {
+    exec(): Promise<DetectedElement[]>;
+}
+export declare class ExecGetter extends FluentBase implements ExecutableGetter {
+    exec(): Promise<DetectedElement[]>;
+}
+export declare class FluentFiltersGetter extends FluentBase {
+    /**
+     * Filters for a UI element 'wizard item active'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    wizardItemActive(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'wizard item'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    wizardItem(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'wizard'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    wizard(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'windows bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    windowsBar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'window'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    window(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'video'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    video(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'url'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    url(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'tooltip'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tooltip(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'textfield'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    textfield(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'textarea'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    textarea(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'table row'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tableRow(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'table header'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tableHeader(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'table column'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tableColumn(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'table'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    table(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'tab selected'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tabSelected(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'tab bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tabBar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'tab active'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tabActive(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'tab'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    tab(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'switch enabled'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    switchEnabled(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'switch disabled'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    switchDisabled(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'status bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    statusBar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'slider indicator'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    sliderIndicator(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'slider'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    slider(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'sidebar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    sidebar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'scroll bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    scrollBar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'rect'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    rect(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'recaptcha'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    recaptcha(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'rate'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    rate(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'radio button unselected'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    radioButtonUnselected(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'radio button selected'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    radioButtonSelected(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'progressbar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    progressbar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'progress bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    progressBar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'popover'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    popover(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'pil'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    pil(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'password'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    password(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'pager'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    pager(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'navigation bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    navigationBar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'mouse text'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    mouseText(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'mouse pointer'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    mousePointer(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'mouse cursor'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    mouseCursor(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'modal'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    modal(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'message box'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    messageBox(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'map'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    map(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'logo'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    logo(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'link'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    link(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'keyboard'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    keyboard(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'image'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    image(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'header'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    header(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'footer'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    footer(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'flag'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    flag(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'dropdown menu'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    dropdownMenu(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'divider'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    divider(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'circle'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    circle(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'checkbox unchecked'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    checkboxUnchecked(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'checkbox checked'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    checkboxChecked(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'chart pie'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    chartPie(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'chart'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    chart(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'card'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    card(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'browser bar'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    browserBar(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'breadcrumb'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    breadcrumb(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'banner'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    banner(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'badge'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    badge(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'alert'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    alert(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'unknown'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    unknown(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for an UI element 'button'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    button(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for an UI element 'text'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    text(): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for an UI element 'dropdown'.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    dropdown(): FluentFiltersOrRelationsGetter;
+    /**
+     * 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(): FluentFiltersOrRelationsGetter;
+    /**
+     * 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: CustomElementJson): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for a UI element 'checkbox' checked or unchecked.
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    checkbox(): FluentFiltersOrRelationsGetter;
+    /**
+     * 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: string): FluentFiltersOrRelationsGetter;
+    /**
+     * 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: string): FluentFiltersOrRelationsGetter;
+    /**
+     * 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: string): FluentFiltersOrRelationsGetter;
+    /**
+     * 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: string): FluentFiltersOrRelationsGetter;
+    /**
+     * Filters for elements having a specific color.
+     *
+     * @param {COLOR} color - A color to match
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    colored(color: COLOR): FluentFiltersOrRelationsGetter;
+}
+export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
+    /**
+     * 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(): FluentFiltersGetter;
+    /**
+     * 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(): FluentFiltersGetter;
+    /**
+     * 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(): FluentFiltersGetter;
+    /**
+     * 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(): FluentFiltersGetter;
+    /**
+     * 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(): FluentFiltersGetter;
+    /**
+     * 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(): FluentFiltersGetter;
+    /**
+     * 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(): FluentFiltersGetter;
+    /**
+    * Returns a list of detected elements
+    *
+    * @return {DetectedElement[]}
+    */
+    exec(): Promise<DetectedElement[]>;
+}
+export declare abstract class Getter extends FluentCommand {
+    /**
+     * Returns the filtered element
+     *
+     * @return {FluentFiltersGetter}
+     */
+    get(): FluentFiltersGetter;
+    /**
+     * Returns all detected elements
+     *
+     * @return {ExecGetter}
+     */
+    getAll(): ExecGetter;
+    abstract getterExecutor(instruction: string, customElements: CustomElementJson[]): Promise<DetectedElement[]>;
+}
+export declare abstract class ApiCommands extends Getter {
 }
 export {};