askui 0.17.1 → 0.18.1

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

@@ -85,9 +85,11 @@ export declare class FluentFilters extends FluentBase {
      *
      * **Examples:**
      * ```typescript
-     * await aui.moveMouseTo().button().exec()
+     * await aui.click().button().contains().text().withText('Google Search').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/button.gif)
+     *
      * @return {FluentFiltersOrRelations}
      */
     button(): FluentFiltersOrRelations;
@@ -121,13 +123,20 @@ export declare class FluentFilters extends FluentBase {
     /**
      * Filters for an UI element 'text'.
      *
-     * Often combined with the filter `withText()` as shown in the below examples.
+     * Takes an optional parameter to filter for a specific text.
+     * See the examples below.
+     *
      * See also the filters `withTextRegex()` and `withExactText()`
      *
      * **Examples:**
      * ```typescript
-     * await aui.click().text().withText('Password').exec();
+     * await aui.click().text().exec();
+     * await aui.click().text('Username').exec();
+     *
+     * // Matching with an exact text
      * await aui.click().text().withExactText('Username').exec();
+     *
+     * // Matching with a regex
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
@@ -144,13 +153,17 @@ export declare class FluentFilters extends FluentBase {
      * icon().withText('plus')
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/icon.gif)
+     *
      * **Note:** This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
      *
      * @return {FluentFiltersOrRelations}
      */
     icon(): FluentFiltersOrRelations;
     /**
-     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element that is not recognized by our machine learning models by default. It can also be used for pixel assertions of elements using classical [template matching](https://en.wikipedia.org/wiki/Template_matching).
+     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     *
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
      *
      * **Example**
      * ```typescript
@@ -160,6 +173,7 @@ export declare class FluentFilters extends FluentBase {
      *         customImage: './logo.png', // required
      *         name: 'myLogo', // optional
      *         threshold: 0.9, // optional, defaults to 0.9
+     *         stopThreshold: 0.9, // optional, defaults to 0.9
      *         rotationDegreePerStep: 0, // optional, defaults to 0
      *         imageCompareFormat: 'grayscale', // optional, defaults to 'grayscale'
      *         // mask:{x:0, y:0}[] // optional, a polygon to match only a certain area of the custom element
@@ -174,12 +188,13 @@ export declare class FluentFilters extends FluentBase {
      * - **name** (*`string`, optional*):
      *     - A unique name that can be used for filtering for the custom element. If not given, any text inside the custom image will be detected via OCR.
      * - **threshold** (*`number`, optional*):
-     *     - A threshold for how much a UI element needs to be similar to the custom element as defined. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     * - **stopThreshold** (*`number`, optional*):
+     *     - A threshold for when to stop searching for UI elements similar to the custom element. As soon as UI elements have been found that are at least as similar as the `stopThreshold`, the search is going to stop. After that elements are filtered using the `threshold`. Because of that the `stopThreshold` should be greater than or equal to `threshold`. It is primarily to be used as a speed improvement (by lowering the value). Takes values between `0.0` and `1.0`. Defaults to `0.9`.
      * - **rotationDegreePerStep** (*`number`, optional*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
-     * - **imageCompareFormat** (*`'RGB' | 'grayscale'`, optional*):
-     *     - The color compare style. 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three color. Defaults to 'grayscale'.
-     * of the given custom image.
+     * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
+     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -196,10 +211,14 @@ export declare class FluentFilters extends FluentBase {
      * await aui.click().image().exec();
      *
      * // Works if you have an image with
-     * // a caption text below
-     * await aui.click().image().above().text().withText('The caption').exec();
+     * // a text below
+     * await aui.click().image().above().text().withText('Automating WebGL').exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/image.gif)
+     *
+     *
+     *
      * @return {FluentFiltersOrRelations}
      */
     image(): FluentFiltersOrRelations;
@@ -216,11 +235,21 @@ export declare class FluentFilters extends FluentBase {
      * await aui.typeIn('Oh yeah').textfield().below().text().withText('E-Mail Address').exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/textfield.gif)
+     *
+     *
+     *
      * @return {FluentFiltersOrRelations}
      */
     textfield(): FluentFiltersOrRelations;
     /**
-     * Filters for similar (doesn't need to be a 100% equal) text.
+     * Filters for similar -- meaning >70% similar -- text.
+     *
+     * Takes an optional parameter to specify the similarity. Usually you need the optional parameter for long texts you want to match precisely.
+     *
+     * _We use [RapidFuzz](https://maxbachmann.github.io/RapidFuzz/Usage/fuzz.html#ratio) which calculates the similarity like this:_
+     *
+     * `1 - (distance / (lengthString1 + lengthString2))`
      *
      * **Examples:**
      * ```typescript
@@ -235,6 +264,11 @@ export declare class FluentFilters extends FluentBase {
      * // usually false
      * 'atebxtc' === withText('text') => false
      * 'other' === withText('text') => false
+     *
+     * // optional parameter: similarity_score
+     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
+     * '978-0-201-00650-6' == withText('978-0-201-00', 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText('978-0-201-00', 90) => true with 93.75 < 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
@@ -256,6 +290,10 @@ export declare class FluentFilters extends FluentBase {
      * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/withtextregex.gif)
+     *
+     *
+     *
      * @param {string} regex_pattern - A regex pattern
      *
      * @return {FluentFiltersOrRelations}
@@ -277,6 +315,10 @@ export declare class FluentFilters extends FluentBase {
      * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/withexacttext.gif)
+     *
+     *
+     *
      * @param {string} text - A text to be matched.
      *
      * @return {FluentFiltersOrRelations}
@@ -301,12 +343,13 @@ export declare class FluentFilters extends FluentBase {
     /**
      * Filters elements based on a textual description.
      *
-     * ## What Should I Write as Matching Text
+     * **What Should I Write as Matching Text**
+     *
      * The text description inside the `matching()` should describe the element visually.
      * It understands color, some famous company/product names, general descriptions.
      *
-     * It sometimes requires a bit of playing to find a matching description:
-     * E.g. `puzzle piece` can fail here while `an icon showing a puzzle piece` might work.
+     * It sometimes requires a bit of playing around to find a matching description:
+     * E.g. `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally the more detail the better.
      *
      * **Examples:**
@@ -451,14 +494,19 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
     /**
      * Filters for an element right of another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
-     * --------------  --------------
-     * |  leftEl    |  |  rightEl   |
-     * --------------  --------------
+     * --------------  --------------  --------------
+     * |  leftEl    |  |  rightEl0  |  |  rightEl1  |
+     * --------------  --------------  --------------
      *
-     * // Returns rightEl because rightEl is right of leftEl
+     * // Returns rightEl0 because rightEl0 is the first element right of leftEl
      * ...rightEl().rightOf().leftEl()
+     * ...rightEl().rightOf(0).leftEl()
+     * // Returns rightEl1 because rightEl1 is the second element right of leftEl
+     * ...rightEl().rightOf(1).leftEl()
      * // Returns no element because leftEl is left of rightEl
      * ...leftEl().rightOf().rightEl()
      * ```
@@ -470,14 +518,19 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
     /**
      * Filters for an element left of another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
-     * --------------  --------------
-     * |  leftEl    |  |  rightEl   |
-     * --------------  --------------
+     * --------------  --------------  --------------
+     * |  leftEl1   |  |  leftEl0   |  |  rightEl   |
+     * --------------  --------------  --------------
      *
-     * // Returns leftEl because leftEl is left of rightEl
+     * // Returns leftEl0 because leftEl0 is the first element left of rightEl
      * ...leftEl().leftOf().rightEl()
+     * ...leftEl().leftOf(0).rightEl()
+     * // Returns leftEl1 because leftEl1 is the second element left of rightEl
+     * ...leftEl().leftOf(1).rightEl()
      * // Returns no element because rightEl is left of leftEl
      * ...rightEl().leftOf().leftEl()
      * ```
@@ -489,17 +542,25 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
     /**
      * Filters for an element below another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
      * --------------
      * |    text    |
      * --------------
      * --------------
-     * |   button   |
+     * |   button0  |
+     * --------------
+     * --------------
+     * |   button1  |
      * --------------
      *
-     * // Returns button because button is below text
+     * // Returns button0 because button0 is the first button below text
      * ...button().below().text()
+     * ...button().below(0).text()
+     * // Returns button1 because button1  is the second button below text
+     * ...button().below(1).text()
      * // Returns no element because text is above button
      * ...text().below().button()
      * ```
@@ -511,17 +572,25 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
     /**
      * Filters for an element above another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
      * --------------
-     * |    text    |
+     * |   text1    |
+     * --------------
+     * --------------
+     * |   text0    |
      * --------------
      * --------------
      * |   button   |
      * --------------
      *
-     * // Returns text because text is above button
+     * // Returns text0 because text0 is the first element above button
      * ...text().above().button()
+     * ...text().above(0).button()
+     * // Returns text1 because text1 is the second element above button
+     * ...text().above(1).button()
      * // Returns no element because button is below text
      * ...button().above().text()
      * ```
@@ -641,9 +710,11 @@ export declare class FluentFiltersCondition extends FluentBase {
      *
      * **Examples:**
      * ```typescript
-     * await aui.moveMouseTo().button().exec()
+     * await aui.click().button().contains().text().withText('Google Search').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/button.gif)
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     button(): FluentFiltersOrRelationsCondition;
@@ -677,13 +748,20 @@ export declare class FluentFiltersCondition extends FluentBase {
     /**
      * Filters for an UI element 'text'.
      *
-     * Often combined with the filter `withText()` as shown in the below examples.
+     * Takes an optional parameter to filter for a specific text.
+     * See the examples below.
+     *
      * See also the filters `withTextRegex()` and `withExactText()`
      *
      * **Examples:**
      * ```typescript
-     * await aui.click().text().withText('Password').exec();
+     * await aui.click().text().exec();
+     * await aui.click().text('Username').exec();
+     *
+     * // Matching with an exact text
      * await aui.click().text().withExactText('Username').exec();
+     *
+     * // Matching with a regex
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
@@ -700,13 +778,17 @@ export declare class FluentFiltersCondition extends FluentBase {
      * icon().withText('plus')
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/icon.gif)
+     *
      * **Note:** This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
     icon(): FluentFiltersOrRelationsCondition;
     /**
-     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element that is not recognized by our machine learning models by default. It can also be used for pixel assertions of elements using classical [template matching](https://en.wikipedia.org/wiki/Template_matching).
+     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     *
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
      *
      * **Example**
      * ```typescript
@@ -716,6 +798,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      *         customImage: './logo.png', // required
      *         name: 'myLogo', // optional
      *         threshold: 0.9, // optional, defaults to 0.9
+     *         stopThreshold: 0.9, // optional, defaults to 0.9
      *         rotationDegreePerStep: 0, // optional, defaults to 0
      *         imageCompareFormat: 'grayscale', // optional, defaults to 'grayscale'
      *         // mask:{x:0, y:0}[] // optional, a polygon to match only a certain area of the custom element
@@ -730,12 +813,13 @@ export declare class FluentFiltersCondition extends FluentBase {
      * - **name** (*`string`, optional*):
      *     - A unique name that can be used for filtering for the custom element. If not given, any text inside the custom image will be detected via OCR.
      * - **threshold** (*`number`, optional*):
-     *     - A threshold for how much a UI element needs to be similar to the custom element as defined. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     * - **stopThreshold** (*`number`, optional*):
+     *     - A threshold for when to stop searching for UI elements similar to the custom element. As soon as UI elements have been found that are at least as similar as the `stopThreshold`, the search is going to stop. After that elements are filtered using the `threshold`. Because of that the `stopThreshold` should be greater than or equal to `threshold`. It is primarily to be used as a speed improvement (by lowering the value). Takes values between `0.0` and `1.0`. Defaults to `0.9`.
      * - **rotationDegreePerStep** (*`number`, optional*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
-     * - **imageCompareFormat** (*`'RGB' | 'grayscale'`, optional*):
-     *     - The color compare style. 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three color. Defaults to 'grayscale'.
-     * of the given custom image.
+     * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
+     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -752,10 +836,14 @@ export declare class FluentFiltersCondition extends FluentBase {
      * await aui.click().image().exec();
      *
      * // Works if you have an image with
-     * // a caption text below
-     * await aui.click().image().above().text().withText('The caption').exec();
+     * // a text below
+     * await aui.click().image().above().text().withText('Automating WebGL').exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/image.gif)
+     *
+     *
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     image(): FluentFiltersOrRelationsCondition;
@@ -772,11 +860,21 @@ export declare class FluentFiltersCondition extends FluentBase {
      * await aui.typeIn('Oh yeah').textfield().below().text().withText('E-Mail Address').exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/textfield.gif)
+     *
+     *
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     textfield(): FluentFiltersOrRelationsCondition;
     /**
-     * Filters for similar (doesn't need to be a 100% equal) text.
+     * Filters for similar -- meaning >70% similar -- text.
+     *
+     * Takes an optional parameter to specify the similarity. Usually you need the optional parameter for long texts you want to match precisely.
+     *
+     * _We use [RapidFuzz](https://maxbachmann.github.io/RapidFuzz/Usage/fuzz.html#ratio) which calculates the similarity like this:_
+     *
+     * `1 - (distance / (lengthString1 + lengthString2))`
      *
      * **Examples:**
      * ```typescript
@@ -791,6 +889,11 @@ export declare class FluentFiltersCondition extends FluentBase {
      * // usually false
      * 'atebxtc' === withText('text') => false
      * 'other' === withText('text') => false
+     *
+     * // optional parameter: similarity_score
+     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
+     * '978-0-201-00650-6' == withText('978-0-201-00', 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText('978-0-201-00', 90) => true with 93.75 < 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
@@ -812,6 +915,10 @@ export declare class FluentFiltersCondition extends FluentBase {
      * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/withtextregex.gif)
+     *
+     *
+     *
      * @param {string} regex_pattern - A regex pattern
      *
      * @return {FluentFiltersOrRelationsCondition}
@@ -833,6 +940,10 @@ export declare class FluentFiltersCondition extends FluentBase {
      * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/withexacttext.gif)
+     *
+     *
+     *
      * @param {string} text - A text to be matched.
      *
      * @return {FluentFiltersOrRelationsCondition}
@@ -857,12 +968,13 @@ export declare class FluentFiltersCondition extends FluentBase {
     /**
      * Filters elements based on a textual description.
      *
-     * ## What Should I Write as Matching Text
+     * **What Should I Write as Matching Text**
+     *
      * The text description inside the `matching()` should describe the element visually.
      * It understands color, some famous company/product names, general descriptions.
      *
-     * It sometimes requires a bit of playing to find a matching description:
-     * E.g. `puzzle piece` can fail here while `an icon showing a puzzle piece` might work.
+     * It sometimes requires a bit of playing around to find a matching description:
+     * E.g. `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally the more detail the better.
      *
      * **Examples:**
@@ -1007,14 +1119,19 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
     /**
      * Filters for an element right of another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
-     * --------------  --------------
-     * |  leftEl    |  |  rightEl   |
-     * --------------  --------------
+     * --------------  --------------  --------------
+     * |  leftEl    |  |  rightEl0  |  |  rightEl1  |
+     * --------------  --------------  --------------
      *
-     * // Returns rightEl because rightEl is right of leftEl
+     * // Returns rightEl0 because rightEl0 is the first element right of leftEl
      * ...rightEl().rightOf().leftEl()
+     * ...rightEl().rightOf(0).leftEl()
+     * // Returns rightEl1 because rightEl1 is the second element right of leftEl
+     * ...rightEl().rightOf(1).leftEl()
      * // Returns no element because leftEl is left of rightEl
      * ...leftEl().rightOf().rightEl()
      * ```
@@ -1026,14 +1143,19 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
     /**
      * Filters for an element left of another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
-     * --------------  --------------
-     * |  leftEl    |  |  rightEl   |
-     * --------------  --------------
+     * --------------  --------------  --------------
+     * |  leftEl1   |  |  leftEl0   |  |  rightEl   |
+     * --------------  --------------  --------------
      *
-     * // Returns leftEl because leftEl is left of rightEl
+     * // Returns leftEl0 because leftEl0 is the first element left of rightEl
      * ...leftEl().leftOf().rightEl()
+     * ...leftEl().leftOf(0).rightEl()
+     * // Returns leftEl1 because leftEl1 is the second element left of rightEl
+     * ...leftEl().leftOf(1).rightEl()
      * // Returns no element because rightEl is left of leftEl
      * ...rightEl().leftOf().leftEl()
      * ```
@@ -1045,17 +1167,25 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
     /**
      * Filters for an element below another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
      * --------------
      * |    text    |
      * --------------
      * --------------
-     * |   button   |
+     * |   button0  |
+     * --------------
+     * --------------
+     * |   button1  |
      * --------------
      *
-     * // Returns button because button is below text
+     * // Returns button0 because button0 is the first button below text
      * ...button().below().text()
+     * ...button().below(0).text()
+     * // Returns button1 because button1  is the second button below text
+     * ...button().below(1).text()
      * // Returns no element because text is above button
      * ...text().below().button()
      * ```
@@ -1067,17 +1197,25 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
     /**
      * Filters for an element above another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
      * --------------
-     * |    text    |
+     * |   text1    |
+     * --------------
+     * --------------
+     * |   text0    |
      * --------------
      * --------------
      * |   button   |
      * --------------
      *
-     * // Returns text because text is above button
+     * // Returns text0 because text0 is the first element above button
      * ...text().above().button()
+     * ...text().above(0).button()
+     * // Returns text1 because text1 is the second element above button
+     * ...text().above(1).button()
      * // Returns no element because button is below text
      * ...button().above().text()
      * ```
@@ -1145,12 +1283,12 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * **Examples:**
      * ```typescript
      * // Stops execution at this point when the element does not exist.
-     * await aui.expect().text().withText('Login').exists().exec()
+     * await aui.expect().text('Login').exists().exec()
      *
      * // This will catch the error and log a message
      * // But the execution will continue afterwards
      * try {
-     *     await aui.expect().text().withText('Login').exists().exec()
+     *     await aui.expect().text('Login').exists().exec()
      * } catch (error) {
      *     console.log('Too bad we could not find the element!');
      * }
@@ -1169,12 +1307,12 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * **Examples:**
      * ```typescript
      * // Stops execution at this point when the element does exist.
-     * await aui.expect().text().withText('Login').notExists().exec()
+     * await aui.expect().text('Login').notExists().exec()
      *
      * // This will catch the error and log a message
      * // But the execution will continue afterwards
      * try {
-     *     await aui.expect().text().withText('Login').notExists().exec()
+     *     await aui.expect().text('Login').notExists().exec()
      * } catch (error) {
      *     console.log('Too bad we could find the element!');
      * }
@@ -1195,8 +1333,8 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Examples:**
      * ```typescript
-     * await aui.expect().text().withText('Login').exists().exec()
-     * await aui.expect().text().withText('Login').notExists().exec()
+     * await aui.expect().text('Login').exists().exec()
+     * await aui.expect().text('Login').notExists().exec()
      * ```
      *
      * @return {FluentFiltersCondition}
@@ -1209,9 +1347,13 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Example:**
      * ```typescript
-     * await aui.click().button().withText('Submit').exec()
+     * await aui.click().button().withText('Google Search').exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/click.gif)
+     *
+     *
+     *
      * @return {FluentFilters}
      */
     click(): FluentFilters;
@@ -1220,9 +1362,13 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Example:**
      * ```typescript
-     * await aui.moveMouseTo().button().withText('Submit').exec()
+     * await aui.moveMouseTo().text().withText('Grinning_Face').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/movemouseto.gif)
+     *
+     *
+     *
      * @return {FluentFilters}
      */
     moveMouseTo(): FluentFilters;
@@ -1252,9 +1398,11 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Example:**
      * ```typescript
-     * await aui.scroll(0, 10).textarea().exec()
+     * await aui.scrollInside(0,-500).text().withText('Bottom sheet').exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/scrollinside.gif)
+     *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
      *
@@ -1304,12 +1452,14 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Examples:**
      * ```typescript
-     * await aui.type('Type some text').exec()
+     * await aui.type('askui@askui.com').exec()
      *
      * // mask the text so it is not send to the askui-inference server
      * await aui.type('Type some text', { isSecret: true, secretMask: '**' }).exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/type.gif)
+     *
      * @param {string} text - A text to type
      *
      * @return {Exec}
@@ -1320,9 +1470,11 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Example:**
      * ```typescript
-     * await aui.moveMouseRelatively(20, 20).exec();
+     * await aui.moveMouseRelatively(0, 50).exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/movemouserelatively.gif)
+     *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
      *
@@ -1339,6 +1491,8 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.moveMouse(500, 500).exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/moveMouse.gif)
+     *
      * @param {number} x_coordinate - A (positive/negative) x coordinate.
      * @param {number} y_coordinate - A (positive/negative) y coordinate.
      *
@@ -1354,10 +1508,12 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Example:**
      * ```typescript
-     * // Scroll 10 up in y direction
-     * await aui.scroll(0, 10).exec()
+     * // Scroll 500 pixels down in y direction
+     * await aui.scroll(0, -500).exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/scroll.gif)
+     *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
      *
@@ -1448,6 +1604,8 @@ export declare abstract class FluentCommand extends FluentBase {
      * await aui.mouseDoubleLeftClick().exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/mousedoubleleftclick.gif)
+     *
      * @return {Exec}
      */
     mouseDoubleLeftClick(): Exec;
@@ -1486,22 +1644,34 @@ export declare abstract class FluentCommand extends FluentBase {
     /**
      * Toggles mouse down (Left mouse key/tap).
      *
+     *  This is the equivalent to **mouse-left-press-and-hold**. It holds the mouse button until the `mouseToogleUp()` is called. Often combined with `mouseToggleUP` to automate **drag-and-drop**.
+     *
      * **Example:**
      * ```typescript
      * await aui.mouseToggleDown().exec();
+     * await aui.moveMouseRelatively(-400,0).exec();
+     * await aui.mouseToggleUp().exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/mouseToggleDownUp.gif)
+     *
      * @return {Exec}
      */
     mouseToggleDown(): Exec;
     /**
      * Toggles mouse up (Left mouse key/tap).
      *
+     * This is the equivalent to releasing the pressing mouse left button. Often combined with `mouseToggleDown()` to automate **drag-and-drop**.
+     *
      * **Example:**
      * ```typescript
+     * await aui.mouseToggleDown().exec();
+     * await aui.moveMouseRelatively(-400,0).exec();
      * await aui.mouseToggleUp().exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/mouseToggleDownUp.gif)
+     *
      * @return {Exec}
      */
     mouseToggleUp(): Exec;
@@ -1510,8 +1680,13 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Operating system specific mappings:**
      * 1. Windows: `command`-key maps to `windows`-key
-     * ---
      *
+     * **Examples:**
+     * ```typescript
+     * await aui.pressThreeKeys('control', 'command' 'space').exec();
+     * ```
+     *
+     * ![](https://docs.askui.com/img/gif/pressThreeKeys.gif)
      *
      * @param {MODIFIER_KEY} first_key - A modifier key
      * @param {MODIFIER_KEY} second_key - A modifier key
@@ -1539,8 +1714,13 @@ export declare abstract class FluentCommand extends FluentBase {
      *
      * **Operating system specific mappings:**
      * 1. Windows: `command`-key maps to `windows`-key
-     * ---
      *
+     * **Examples:**
+     * ```typescript
+     * await aui.pressKey('tab').exec();
+     * ```
+     *
+     * ![](https://docs.askui.com/img/gif/pressKey.gif)
      *
      * @param {PC_AND_MODIFIER_KEY} key - A key
      *
@@ -1558,7 +1738,15 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     pressAndroidThirdKey(first_key: ANDROID_KEY, second_key: ANDROID_KEY, third_key: ANDROID_KEY): Exec;
     /**
-     * Press two Android keys like `ALT+F4`
+     * Press two Android keys like `volume_down+power`
+     * See [API docs](https://docs.askui.com/docs/api/Actions/pressandroidtwokey) for available keys.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.pressAndroidTwoKey('volume_down', 'power').exec();
+     * ```
+     *
+     * ![](https://docs.askui.com/img/gif/pressAndroidTwoKey.gif)
      *
      * @param {ANDROID_KEY} first_key - A Android key
      * @param {ANDROID_KEY} second_key - A Android key
@@ -1567,7 +1755,15 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     pressAndroidTwoKey(first_key: ANDROID_KEY, second_key: ANDROID_KEY): Exec;
     /**
-     * Press one Android key like `DEL`
+     * Press one Android key like `del`
+     * See [API docs](https://docs.askui.com/docs/api/Actions/pressandroidtwokey) for available keys.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.pressAndroidKey('notification').exec();
+     * ```
+     *
+     * ![](https://docs.askui.com/img/gif/pressAndroidKey.gif)
      *
      * @param {ANDROID_KEY} key - A Android key
      *
@@ -1642,9 +1838,11 @@ export declare class FluentFiltersGetter extends FluentBase {
      *
      * **Examples:**
      * ```typescript
-     * await aui.moveMouseTo().button().exec()
+     * await aui.click().button().contains().text().withText('Google Search').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/button.gif)
+     *
      * @return {FluentFiltersOrRelationsGetter}
      */
     button(): FluentFiltersOrRelationsGetter;
@@ -1678,13 +1876,20 @@ export declare class FluentFiltersGetter extends FluentBase {
     /**
      * Filters for an UI element 'text'.
      *
-     * Often combined with the filter `withText()` as shown in the below examples.
+     * Takes an optional parameter to filter for a specific text.
+     * See the examples below.
+     *
      * See also the filters `withTextRegex()` and `withExactText()`
      *
      * **Examples:**
      * ```typescript
-     * await aui.click().text().withText('Password').exec();
+     * await aui.click().text().exec();
+     * await aui.click().text('Username').exec();
+     *
+     * // Matching with an exact text
      * await aui.click().text().withExactText('Username').exec();
+     *
+     * // Matching with a regex
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
@@ -1701,13 +1906,17 @@ export declare class FluentFiltersGetter extends FluentBase {
      * icon().withText('plus')
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/icon.gif)
+     *
      * **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 element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element that is not recognized by our machine learning models by default. It can also be used for pixel assertions of elements using classical [template matching](https://en.wikipedia.org/wiki/Template_matching).
+     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     *
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
      *
      * **Example**
      * ```typescript
@@ -1717,6 +1926,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      *         customImage: './logo.png', // required
      *         name: 'myLogo', // optional
      *         threshold: 0.9, // optional, defaults to 0.9
+     *         stopThreshold: 0.9, // optional, defaults to 0.9
      *         rotationDegreePerStep: 0, // optional, defaults to 0
      *         imageCompareFormat: 'grayscale', // optional, defaults to 'grayscale'
      *         // mask:{x:0, y:0}[] // optional, a polygon to match only a certain area of the custom element
@@ -1731,12 +1941,13 @@ export declare class FluentFiltersGetter extends FluentBase {
      * - **name** (*`string`, optional*):
      *     - A unique name that can be used for filtering for the custom element. If not given, any text inside the custom image will be detected via OCR.
      * - **threshold** (*`number`, optional*):
-     *     - A threshold for how much a UI element needs to be similar to the custom element as defined. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     *     - A threshold for how much a UI element needs to be similar to the custom element as defined by the image. Takes values between `0.0` (== all elements are recognized as the custom element which is probably not what you want) and `1.0` (== elements need to look exactly like the `customImage` which is unlikely to be achieved as even minor differences count). Defaults to `0.9`.
+     * - **stopThreshold** (*`number`, optional*):
+     *     - A threshold for when to stop searching for UI elements similar to the custom element. As soon as UI elements have been found that are at least as similar as the `stopThreshold`, the search is going to stop. After that elements are filtered using the `threshold`. Because of that the `stopThreshold` should be greater than or equal to `threshold`. It is primarily to be used as a speed improvement (by lowering the value). Takes values between `0.0` and `1.0`. Defaults to `0.9`.
      * - **rotationDegreePerStep** (*`number`, optional*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
-     * - **imageCompareFormat** (*`'RGB' | 'grayscale'`, optional*):
-     *     - The color compare style. 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three color. Defaults to 'grayscale'.
-     * of the given custom image.
+     * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
+     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -1753,10 +1964,14 @@ export declare class FluentFiltersGetter extends FluentBase {
      * await aui.click().image().exec();
      *
      * // Works if you have an image with
-     * // a caption text below
-     * await aui.click().image().above().text().withText('The caption').exec();
+     * // a text below
+     * await aui.click().image().above().text().withText('Automating WebGL').exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/image.gif)
+     *
+     *
+     *
      * @return {FluentFiltersOrRelationsGetter}
      */
     image(): FluentFiltersOrRelationsGetter;
@@ -1773,11 +1988,21 @@ export declare class FluentFiltersGetter extends FluentBase {
      * await aui.typeIn('Oh yeah').textfield().below().text().withText('E-Mail Address').exec();
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/textfield.gif)
+     *
+     *
+     *
      * @return {FluentFiltersOrRelationsGetter}
      */
     textfield(): FluentFiltersOrRelationsGetter;
     /**
-     * Filters for similar (doesn't need to be a 100% equal) text.
+     * Filters for similar -- meaning >70% similar -- text.
+     *
+     * Takes an optional parameter to specify the similarity. Usually you need the optional parameter for long texts you want to match precisely.
+     *
+     * _We use [RapidFuzz](https://maxbachmann.github.io/RapidFuzz/Usage/fuzz.html#ratio) which calculates the similarity like this:_
+     *
+     * `1 - (distance / (lengthString1 + lengthString2))`
      *
      * **Examples:**
      * ```typescript
@@ -1792,6 +2017,11 @@ export declare class FluentFiltersGetter extends FluentBase {
      * // usually false
      * 'atebxtc' === withText('text') => false
      * 'other' === withText('text') => false
+     *
+     * // optional parameter: similarity_score
+     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
+     * '978-0-201-00650-6' == withText('978-0-201-00', 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText('978-0-201-00', 90) => true with 93.75 < 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
@@ -1813,6 +2043,10 @@ export declare class FluentFiltersGetter extends FluentBase {
      * await aui.get().text().withTextRegex('\b[Ss]\w+').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/withtextregex.gif)
+     *
+     *
+     *
      * @param {string} regex_pattern - A regex pattern
      *
      * @return {FluentFiltersOrRelationsGetter}
@@ -1834,6 +2068,10 @@ export declare class FluentFiltersGetter extends FluentBase {
      * await aui.moveMouseTo().text().withExactText('Password').exec()
      * ```
      *
+     * ![](https://docs.askui.com/img/gif/withexacttext.gif)
+     *
+     *
+     *
      * @param {string} text - A text to be matched.
      *
      * @return {FluentFiltersOrRelationsGetter}
@@ -1858,12 +2096,13 @@ export declare class FluentFiltersGetter extends FluentBase {
     /**
      * Filters elements based on a textual description.
      *
-     * ## What Should I Write as Matching Text
+     * **What Should I Write as Matching Text**
+     *
      * The text description inside the `matching()` should describe the element visually.
      * It understands color, some famous company/product names, general descriptions.
      *
-     * It sometimes requires a bit of playing to find a matching description:
-     * E.g. `puzzle piece` can fail here while `an icon showing a puzzle piece` might work.
+     * It sometimes requires a bit of playing around to find a matching description:
+     * E.g. `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally the more detail the better.
      *
      * **Examples:**
@@ -2008,14 +2247,19 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
     /**
      * Filters for an element right of another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
-     * --------------  --------------
-     * |  leftEl    |  |  rightEl   |
-     * --------------  --------------
+     * --------------  --------------  --------------
+     * |  leftEl    |  |  rightEl0  |  |  rightEl1  |
+     * --------------  --------------  --------------
      *
-     * // Returns rightEl because rightEl is right of leftEl
+     * // Returns rightEl0 because rightEl0 is the first element right of leftEl
      * ...rightEl().rightOf().leftEl()
+     * ...rightEl().rightOf(0).leftEl()
+     * // Returns rightEl1 because rightEl1 is the second element right of leftEl
+     * ...rightEl().rightOf(1).leftEl()
      * // Returns no element because leftEl is left of rightEl
      * ...leftEl().rightOf().rightEl()
      * ```
@@ -2027,14 +2271,19 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
     /**
      * Filters for an element left of another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
-     * --------------  --------------
-     * |  leftEl    |  |  rightEl   |
-     * --------------  --------------
+     * --------------  --------------  --------------
+     * |  leftEl1   |  |  leftEl0   |  |  rightEl   |
+     * --------------  --------------  --------------
      *
-     * // Returns leftEl because leftEl is left of rightEl
+     * // Returns leftEl0 because leftEl0 is the first element left of rightEl
      * ...leftEl().leftOf().rightEl()
+     * ...leftEl().leftOf(0).rightEl()
+     * // Returns leftEl1 because leftEl1 is the second element left of rightEl
+     * ...leftEl().leftOf(1).rightEl()
      * // Returns no element because rightEl is left of leftEl
      * ...rightEl().leftOf().leftEl()
      * ```
@@ -2046,17 +2295,25 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
     /**
      * Filters for an element below another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
      * --------------
      * |    text    |
      * --------------
      * --------------
-     * |   button   |
+     * |   button0  |
+     * --------------
+     * --------------
+     * |   button1  |
      * --------------
      *
-     * // Returns button because button is below text
+     * // Returns button0 because button0 is the first button below text
      * ...button().below().text()
+     * ...button().below(0).text()
+     * // Returns button1 because button1  is the second button below text
+     * ...button().below(1).text()
      * // Returns no element because text is above button
      * ...text().below().button()
      * ```
@@ -2068,17 +2325,25 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
     /**
      * Filters for an element above another element.
      *
+     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     *
      * **Examples:**
      * ```typescript
      * --------------
-     * |    text    |
+     * |   text1    |
+     * --------------
+     * --------------
+     * |   text0    |
      * --------------
      * --------------
      * |   button   |
      * --------------
      *
-     * // Returns text because text is above button
+     * // Returns text0 because text0 is the first element above button
      * ...text().above().button()
+     * ...text().above(0).button()
+     * // Returns text1 because text1 is the second element above button
+     * ...text().above(1).button()
      * // Returns no element because button is below text
      * ...button().above().text()
      * ```
@@ -2153,7 +2418,7 @@ export declare abstract class Getter extends FluentCommand {
      *
      * **Examples:**
      * ```typescript
-     * const text = await aui.get().text().withText('Sign').exec();
+     * const text = await aui.get().text('Sign').exec();
      * console.log(text);
      * ```
      * ```text