askui 0.6.1 → 0.7.1

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

@@ -413,6 +413,11 @@ export declare class FluentFilters extends FluentBase {
     /**
      * Filters for an UI element 'button'.
      *
+     * **Examples:**
+     * ```typescript
+     * await aui.moveMouseTo().button().exec()
+     * ```
+     *
      * @return {FluentFiltersOrRelations}
      */
     button(): FluentFiltersOrRelations;
@@ -467,8 +472,17 @@ export declare class FluentFilters extends FluentBase {
      * ```typescript
      * 'text' === withText('text') => true
      * 'test' === withText('text') => true
+     * 'Test' === withText('text') => true
+     * 'Text' === withText('text') => true
+     * 'TEXT' === withText('text') => true
+     * 'texst' === withText('text') => true
+     * 'texts' === withText('text') => true
+     *
+     * // usually false
+     * 'atebxtc' === withText('text') => false
      * 'other' === withText('text') => false
      * ```
+     * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
      *
@@ -484,9 +498,11 @@ export declare class FluentFilters extends FluentBase {
      * '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
+     *
+     * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
-     * @param {string} regex_pattern - An regex pattern
+     * @param {string} regex_pattern - A regex pattern
      *
      * @return {FluentFiltersOrRelations}
      */
@@ -503,6 +519,8 @@ export declare class FluentFilters extends FluentBase {
      * 'text' === withExactText('text') => true
      * 'test' === withExactText('text') => false
      * 'other' === withExactText('text') => false
+     *
+     * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
      * @param {string} text - A text to be matched.
@@ -519,20 +537,13 @@ export declare class FluentFilters extends FluentBase {
      * 'This is an text' === containsText('other text') => false
      * 'This is an text' === containsText('other') => false
      * ```
+     * ![](https://docs.askui.com/img/gif/containsText.gif)
      *
      * @param {string} text - A text to be matched.
      *
      * @return {FluentFiltersOrRelations}
      */
     containsText(text: string): FluentFiltersOrRelations;
-    /**
-     * Filters for elements having a specific color.
-     *
-     * @param {COLOR} color - A color to match
-     *
-     * @return {FluentFiltersOrRelations}
-     */
-    colored(color: COLOR): FluentFiltersOrRelations;
 }
 export declare class FluentFiltersOrRelations extends FluentFilters {
     /**
@@ -563,7 +574,6 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *   DetectedElement {
      *      name: 'BUTTON',
      *      text: 'button',
-     *      colors: [ 'red', 'black', 'red' ],
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -583,21 +593,19 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * **Examples:**
      * ```text
      * example scene:
-     *  --------------------------   --------------------------
-     *  |  icon user colored black | |  icon  user colored red |
-     *  --------------------------   --------------------------
-     * ```
+     *  ---------------   ----------------
+     *  |  icon user  |   |  icon search |
+     *  ---------------   ---------------n```
      * ```typescript
-     * const icons = await aui.get().icon().withText('user').exec();
+     * const icons = await aui.get().icon().exec();
      * console.log(icons);
      * ```
-     * Using only the filter withText, the get command will return both icons because they share the same text
+     * Using only the filter icon, the get command will return both icons
      * ```text
      * console output: [
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'user',
-     *      colors: [ 'black', 'black', 'black' ],
      *      bndbox: BoundingBox {
      *         xmin: 1000,
      *         ymin: 1010,
@@ -607,8 +615,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *   },
      *   DetectedElement {
      *      name: 'ICON',
-     *      text: 'user',
-     *      colors: [ 'red', 'red', 'red' ],
+     *      text: 'search',
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -620,16 +627,15 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * 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()
+     * const icons = await aui.get().icon().and().withText('user').exec()
      * console.log(icons)
      * ```
-     * The get command returns only the red icon although both icons have the same text
+     * The get command returns only the user icon although both elements are icons
      * ```text
      *  console output: [
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'user',
-     *      colors: [ 'red', 'red', 'red' ],
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -661,6 +667,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * // Returns nothing because innerEl is not inside outerEl
      * ...outerEl().in().innerEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/in.gif)
      *
      * @return {FluentFilters}
      */
@@ -679,6 +686,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * // Returns no element because leftEl is left of rightEl
      * ...leftEl().rightOf().rightEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
      * @return {FluentFilters}
      */
@@ -697,6 +705,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * // Returns no element because rightEl is left of leftEl
      * ...rightEl().leftOf().leftEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
      * @return {FluentFilters}
      */
@@ -718,6 +727,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * // Returns no element because text is above button
      * ...text().below().button()
      * ```
+     * ![](https://docs.askui.com/img/gif/below.gif)
      *
      * @return {FluentFilters}
      */
@@ -739,6 +749,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * // Returns no element because button is below text
      * ...button().above().text()
      * ```
+     * ![](https://docs.askui.com/img/gif/above.gif)
      *
      * @return {FluentFilters}
      */
@@ -764,6 +775,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * // Returns button 1 because button 1 is nearer to the text than button 2
      * ...button().nearestTo().text()
      * ```
+     * ![](https://docs.askui.com/img/gif/nearestTo.gif)
      *
      * @return {FluentFilters}
      */
@@ -786,6 +798,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * //  Returns no element because innerEl contains no outerEl
      * ...innerEl().contains().outerEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/contains.gif)
      *
      * @return {FluentFilters}
      */
@@ -1180,6 +1193,11 @@ export declare class FluentFiltersCondition extends FluentBase {
     /**
      * Filters for an UI element 'button'.
      *
+     * **Examples:**
+     * ```typescript
+     * await aui.moveMouseTo().button().exec()
+     * ```
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     button(): FluentFiltersOrRelationsCondition;
@@ -1234,8 +1252,17 @@ export declare class FluentFiltersCondition extends FluentBase {
      * ```typescript
      * 'text' === withText('text') => true
      * 'test' === withText('text') => true
+     * 'Test' === withText('text') => true
+     * 'Text' === withText('text') => true
+     * 'TEXT' === withText('text') => true
+     * 'texst' === withText('text') => true
+     * 'texts' === withText('text') => true
+     *
+     * // usually false
+     * 'atebxtc' === withText('text') => false
      * 'other' === withText('text') => false
      * ```
+     * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
      *
@@ -1251,9 +1278,11 @@ export declare class FluentFiltersCondition extends FluentBase {
      * '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
+     *
+     * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
-     * @param {string} regex_pattern - An regex pattern
+     * @param {string} regex_pattern - A regex pattern
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
@@ -1270,6 +1299,8 @@ export declare class FluentFiltersCondition extends FluentBase {
      * 'text' === withExactText('text') => true
      * 'test' === withExactText('text') => false
      * 'other' === withExactText('text') => false
+     *
+     * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
      * @param {string} text - A text to be matched.
@@ -1286,20 +1317,13 @@ export declare class FluentFiltersCondition extends FluentBase {
      * 'This is an text' === containsText('other text') => false
      * 'This is an text' === containsText('other') => false
      * ```
+     * ![](https://docs.askui.com/img/gif/containsText.gif)
      *
      * @param {string} text - A text to be matched.
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
     containsText(text: string): FluentFiltersOrRelationsCondition;
-    /**
-     * Filters for elements having a specific color.
-     *
-     * @param {COLOR} color - A color to match
-     *
-     * @return {FluentFiltersOrRelationsCondition}
-     */
-    colored(color: COLOR): FluentFiltersOrRelationsCondition;
 }
 export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
     /**
@@ -1330,7 +1354,6 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *   DetectedElement {
      *      name: 'BUTTON',
      *      text: 'button',
-     *      colors: [ 'red', 'black', 'red' ],
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -1350,21 +1373,19 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * **Examples:**
      * ```text
      * example scene:
-     *  --------------------------   --------------------------
-     *  |  icon user colored black | |  icon  user colored red |
-     *  --------------------------   --------------------------
-     * ```
+     *  ---------------   ----------------
+     *  |  icon user  |   |  icon search |
+     *  ---------------   ---------------n```
      * ```typescript
-     * const icons = await aui.get().icon().withText('user').exec();
+     * const icons = await aui.get().icon().exec();
      * console.log(icons);
      * ```
-     * Using only the filter withText, the get command will return both icons because they share the same text
+     * Using only the filter icon, the get command will return both icons
      * ```text
      * console output: [
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'user',
-     *      colors: [ 'black', 'black', 'black' ],
      *      bndbox: BoundingBox {
      *         xmin: 1000,
      *         ymin: 1010,
@@ -1374,8 +1395,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *   },
      *   DetectedElement {
      *      name: 'ICON',
-     *      text: 'user',
-     *      colors: [ 'red', 'red', 'red' ],
+     *      text: 'search',
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -1387,16 +1407,15 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * ```
      * 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()
+     * const icons = await aui.get().icon().and().withText('user').exec()
      * console.log(icons)
      * ```
-     * The get command returns only the red icon although both icons have the same text
+     * The get command returns only the user icon although both elements are icons
      * ```text
      *  console output: [
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'user',
-     *      colors: [ 'red', 'red', 'red' ],
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -1428,6 +1447,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * // Returns nothing because innerEl is not inside outerEl
      * ...outerEl().in().innerEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/in.gif)
      *
      * @return {FluentFiltersCondition}
      */
@@ -1446,6 +1466,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * // Returns no element because leftEl is left of rightEl
      * ...leftEl().rightOf().rightEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
      * @return {FluentFiltersCondition}
      */
@@ -1464,6 +1485,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * // Returns no element because rightEl is left of leftEl
      * ...rightEl().leftOf().leftEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
      * @return {FluentFiltersCondition}
      */
@@ -1485,6 +1507,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * // Returns no element because text is above button
      * ...text().below().button()
      * ```
+     * ![](https://docs.askui.com/img/gif/below.gif)
      *
      * @return {FluentFiltersCondition}
      */
@@ -1506,6 +1529,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * // Returns no element because button is below text
      * ...button().above().text()
      * ```
+     * ![](https://docs.askui.com/img/gif/above.gif)
      *
      * @return {FluentFiltersCondition}
      */
@@ -1531,6 +1555,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * // Returns button 1 because button 1 is nearer to the text than button 2
      * ...button().nearestTo().text()
      * ```
+     * ![](https://docs.askui.com/img/gif/nearestTo.gif)
      *
      * @return {FluentFiltersCondition}
      */
@@ -1553,6 +1578,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * //  Returns no element because innerEl contains no outerEl
      * ...innerEl().contains().outerEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/contains.gif)
      *
      * @return {FluentFiltersCondition}
      */
@@ -1560,12 +1586,22 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
     /**
      * Expects that filtered element exists.
      *
+     * **Examples:**
+     * ```typescript
+     * await aui.expect().text().withText('Login').exists().exec()
+     * ```
+     *
      * @return {ExecCondition}
      */
     exists(): ExecCondition;
     /**
      * Expects that filtered element does not exist.
      *
+     * **Examples:**
+     * ```typescript
+     * await aui.expect().text().withText('Login').notExists().exec()
+     * ```
+     *
      * @return {ExecCondition}
      */
     notExists(): ExecCondition;
@@ -1575,8 +1611,13 @@ declare class ExecCondition extends Exec {
 export declare abstract class FluentCommand extends FluentBase {
     constructor();
     /**
-     * Expects a condition, e.g., `exists()` or `notExits()`,
-     *  e.g., `...expect().text().withText('Login').exists()`.
+     * Expects a condition, e.g., `exists()` or `notExits()`.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.expect().text().withText('Login').exists().exec()
+     * await aui.expect().text().withText('Login').notExists().exec()
+     * ```
      *
      * @return {FluentFiltersCondition}
      */
@@ -1584,17 +1625,36 @@ export declare abstract class FluentCommand extends FluentBase {
     /**
      * Clicks on the filtered element.
      *
+     * **Example:**
+     * ```typescript
+     * await aui.click().button().withText('Submit').exec()
+     * ```
+     *
      * @return {FluentFilters}
      */
     click(): FluentFilters;
     /**
      * Move mouse over the filtered element.
      *
+     * **Example:**
+     * ```typescript
+     * await aui.moveMouseTo().button().withText('Submit').exec()
+     * ```
+     *
      * @return {FluentFilters}
      */
     moveMouseTo(): FluentFilters;
     /**
-     * Types a text inside the filtered element.
+     * Puts the focus on the filtered element and types in the text.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.typeIn('Type some text').textfield().exec()
+     *
+     * // mask the text so it is not send to the askui-inference server
+     * await aui.typeIn('Type some text', { isSecret: true, secretMask: '**' }).textfield().exec()
+     * ```
+     * ![](https://docs.askui.com/img/gif/typeIn.gif)
      *
      * @param {string} text - A text to type
      *
@@ -1604,6 +1664,13 @@ export declare abstract class FluentCommand extends FluentBase {
     /**
      * Moves mouse to the filtered element and scrolls in the x and y direction.
      *
+     * **macOS**: May not work as expected!
+     *
+     * **Example:**
+     * ```typescript
+     * await aui.scroll(0, 10).textarea().exec()
+     * ```
+     *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
      *
@@ -1612,7 +1679,14 @@ export declare abstract class FluentCommand extends FluentBase {
     scrollInside(x_offset: number, y_offset: number): FluentFilters;
     /**
      * Moves the mouse relatively to an element in the direction.
-     * This can be used when the mouse should not hover over on an element anymore.
+     * This can be used when the mouse should not hover over an element anymore.
+     *
+     * **Examples:**
+     * ```typescript
+     * // Move mouse 30 pixels below button
+     * await aui.moveMouseRelativelyTo(0, 30).button().withText('Submit').exec()
+     * ```
+     * ![](https://docs.askui.com/img/gif/moveMouseRelativelyTo.gif)
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
@@ -1621,16 +1695,33 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     moveMouseRelativelyTo(x_offset: number, y_offset: number): FluentFilters;
     /**
-     * Swipe an element in the x and y direction
+     * Swipe an element in the x and y direction.
+     * Holds the left mouse button down on Windows, Linux and macOS and drags the element.
+     * On touch devices it taps the element and then drags it.
+     *
+     * **Example:**
+     * ```typescript
+     * // Swipe the element 500 to the right
+     * await aui.swipe(500, 0).image().exec()
+     * ```
+     * ![](https://docs.askui.com/img/gif/swipe.gif)
      *
-     * @param {number} x_offset - A x direction. positive an negative values are accepted
-     * @param {number} y_offset - A y direction. positive an negative values are accepted
+     * @param {number} x_offset - A x direction. positive and negative values are accepted
+     * @param {number} y_offset - A y direction. positive and negative values are accepted
      *
      * @return {FluentFilters}
      */
     swipe(x_offset: number, y_offset: number): FluentFilters;
     /**
      * Types a text at the current position.
+     * If you need to focus the element first, use typeIn()
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.type('Type some text').exec()
+     *
+     * // mask the text so it is not send to the askui-inference serverawait aui.type('Type some text', { isSecret: true, secretMask: '**' }).exec()
+     * ```
      *
      * @param {string} text - A text to type
      *
@@ -1660,6 +1751,14 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Important**: Mouse must be positioned in a scrollable area.
      *
+     * **macOS**: May not work as expected!
+     *
+     * **Example:**
+     * ```typescript
+     * // Scroll 10 up in y direction
+     * await aui.scroll(0, 10).exec()
+     * ```
+     *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
      *
@@ -1667,7 +1766,13 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     scroll(x_offset: number, y_offset: number): Exec;
     /**
-     * Executes a shell command.
+     * Executes a shell command on the device.
+     *
+     * **Example:**
+     * ```typescript
+     * // Open the lastpass app
+     * await aui.execOnShell('monkey -p com.lastpass.authenticator 1').exec()
+     * ```
      *
      * @param {string} shell_command - A shell command which is executed.
      *
@@ -1711,13 +1816,13 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     mouseDoubleMiddleClick(): Exec;
     /**
-     * Toggles mouse down.
+     * Toggles mouse down (Left mouse key).
      *
      * @return {Exec}
      */
     mouseToggleDown(): Exec;
     /**
-     * Toggles mouse up.
+     * Toggles mouse up (Left mouse key).
      *
      * @return {Exec}
      */
@@ -2172,6 +2277,11 @@ export declare class FluentFiltersGetter extends FluentBase {
     /**
      * Filters for an UI element 'button'.
      *
+     * **Examples:**
+     * ```typescript
+     * await aui.moveMouseTo().button().exec()
+     * ```
+     *
      * @return {FluentFiltersOrRelationsGetter}
      */
     button(): FluentFiltersOrRelationsGetter;
@@ -2226,8 +2336,17 @@ export declare class FluentFiltersGetter extends FluentBase {
      * ```typescript
      * 'text' === withText('text') => true
      * 'test' === withText('text') => true
+     * 'Test' === withText('text') => true
+     * 'Text' === withText('text') => true
+     * 'TEXT' === withText('text') => true
+     * 'texst' === withText('text') => true
+     * 'texts' === withText('text') => true
+     *
+     * // usually false
+     * 'atebxtc' === withText('text') => false
      * 'other' === withText('text') => false
      * ```
+     * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
      *
@@ -2243,9 +2362,11 @@ export declare class FluentFiltersGetter extends FluentBase {
      * '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
+     *
+     * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
-     * @param {string} regex_pattern - An regex pattern
+     * @param {string} regex_pattern - A regex pattern
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
@@ -2262,6 +2383,8 @@ export declare class FluentFiltersGetter extends FluentBase {
      * 'text' === withExactText('text') => true
      * 'test' === withExactText('text') => false
      * 'other' === withExactText('text') => false
+     *
+     * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
      * @param {string} text - A text to be matched.
@@ -2278,20 +2401,13 @@ export declare class FluentFiltersGetter extends FluentBase {
      * 'This is an text' === containsText('other text') => false
      * 'This is an text' === containsText('other') => false
      * ```
+     * ![](https://docs.askui.com/img/gif/containsText.gif)
      *
      * @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 {
     /**
@@ -2322,7 +2438,6 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *   DetectedElement {
      *      name: 'BUTTON',
      *      text: 'button',
-     *      colors: [ 'red', 'black', 'red' ],
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -2342,21 +2457,19 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * **Examples:**
      * ```text
      * example scene:
-     *  --------------------------   --------------------------
-     *  |  icon user colored black | |  icon  user colored red |
-     *  --------------------------   --------------------------
-     * ```
+     *  ---------------   ----------------
+     *  |  icon user  |   |  icon search |
+     *  ---------------   ---------------n```
      * ```typescript
-     * const icons = await aui.get().icon().withText('user').exec();
+     * const icons = await aui.get().icon().exec();
      * console.log(icons);
      * ```
-     * Using only the filter withText, the get command will return both icons because they share the same text
+     * Using only the filter icon, the get command will return both icons
      * ```text
      * console output: [
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'user',
-     *      colors: [ 'black', 'black', 'black' ],
      *      bndbox: BoundingBox {
      *         xmin: 1000,
      *         ymin: 1010,
@@ -2366,8 +2479,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *   },
      *   DetectedElement {
      *      name: 'ICON',
-     *      text: 'user',
-     *      colors: [ 'red', 'red', 'red' ],
+     *      text: 'search',
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -2379,16 +2491,15 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * ```
      * 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()
+     * const icons = await aui.get().icon().and().withText('user').exec()
      * console.log(icons)
      * ```
-     * The get command returns only the red icon although both icons have the same text
+     * The get command returns only the user icon although both elements are icons
      * ```text
      *  console output: [
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'user',
-     *      colors: [ 'red', 'red', 'red' ],
      *      bndbox: BoundingBox {
      *         xmin: 900,
      *         ymin: 910,
@@ -2420,6 +2531,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * // Returns nothing because innerEl is not inside outerEl
      * ...outerEl().in().innerEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/in.gif)
      *
      * @return {FluentFiltersGetter}
      */
@@ -2438,6 +2550,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * // Returns no element because leftEl is left of rightEl
      * ...leftEl().rightOf().rightEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
      * @return {FluentFiltersGetter}
      */
@@ -2456,6 +2569,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * // Returns no element because rightEl is left of leftEl
      * ...rightEl().leftOf().leftEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
      * @return {FluentFiltersGetter}
      */
@@ -2477,6 +2591,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * // Returns no element because text is above button
      * ...text().below().button()
      * ```
+     * ![](https://docs.askui.com/img/gif/below.gif)
      *
      * @return {FluentFiltersGetter}
      */
@@ -2498,6 +2613,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * // Returns no element because button is below text
      * ...button().above().text()
      * ```
+     * ![](https://docs.askui.com/img/gif/above.gif)
      *
      * @return {FluentFiltersGetter}
      */
@@ -2523,6 +2639,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * // Returns button 1 because button 1 is nearer to the text than button 2
      * ...button().nearestTo().text()
      * ```
+     * ![](https://docs.askui.com/img/gif/nearestTo.gif)
      *
      * @return {FluentFiltersGetter}
      */
@@ -2545,6 +2662,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * //  Returns no element because innerEl contains no outerEl
      * ...innerEl().contains().outerEl()
      * ```
+     * ![](https://docs.askui.com/img/gif/contains.gif)
      *
      * @return {FluentFiltersGetter}
      */
@@ -2562,8 +2680,8 @@ export declare abstract class Getter extends FluentCommand {
      * 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();
@@ -2574,7 +2692,6 @@ export declare abstract class Getter extends FluentCommand {
      *   DetectedElement {
      *      name: 'TEXT',
      *      text: 'Sign In',
-     *      colors: [ 'black', 'gray', 'gray' ],
      *      bndbox: BoundingBox {
      *         xmin: 1128.2720982142857,
      *         ymin: 160.21332310267857,
@@ -2593,8 +2710,8 @@ export declare abstract class Getter extends FluentCommand {
      * 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();
@@ -2605,7 +2722,6 @@ export declare abstract class Getter extends FluentCommand {
      *   DetectedElement {
      *      name: 'TEXT',
      *      text: 'Sign In',
-     *      colors: [ 'black', 'gray', 'gray' ],
      *      bndbox: BoundingBox {
      *         xmin: 1128.2720982142857,
      *         ymin: 160.21332310267857,
@@ -2615,7 +2731,6 @@ export declare abstract class Getter extends FluentCommand {
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'search',
-     *      colors: [ 'black', 'red', 'gray' ],
      *      bndbox: BoundingBox {
      *         xmin: 250.8204241071428,
      *         ymin: 300.21332310267857,