askui 0.20.0 → 0.20.2

package/dist/cjs/execution/dsl.js

@@ -1,9 +1,4 @@
 "use strict";
-/* eslint-disable @typescript-eslint/no-use-before-define */
-/* eslint-disable @typescript-eslint/naming-convention */
-/* eslint-disable max-classes-per-file */
-/* eslint-disable max-len */
-// Autogenerated from typescript.template file
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiCommands = exports.Getter = exports.FluentFiltersOrRelationsGetter = exports.FluentFiltersGetter = exports.ExecGetter = exports.FluentCommand = exports.FluentFiltersOrRelationsCondition = exports.FluentFiltersCondition = exports.FluentFiltersOrRelations = exports.FluentFilters = exports.Exec = exports.Separators = void 0;
 var Separators;
@@ -30,8 +25,12 @@ class FluentBase {
         const newParamsList = FluentBase.addParams(paramsList, this._params);
         if (this instanceof FluentCommand) {
             const fluentCommand = this;
-            const customElements = newParamsList.has('customElement') ? newParamsList.get('customElement') : [];
-            const aiElementNames = newParamsList.has('aiElementName') ? newParamsList.get('aiElementName') : [];
+            const customElements = newParamsList.has('customElement')
+                ? newParamsList.get('customElement')
+                : [];
+            const aiElementNames = newParamsList.has('aiElementName')
+                ? newParamsList.get('aiElementName')
+                : [];
             return fluentCommand.fluentCommandExecutor(newCurrentInstruction.trim(), {
                 customElementsJson: customElements,
                 aiElementNames,
@@ -47,8 +46,12 @@ class FluentBase {
         const newParamsList = FluentBase.addParams(paramsList, this._params);
         if (this instanceof Getter) {
             const getter = this;
-            const customElements = newParamsList.has('customElement') ? newParamsList.get('customElement') : [];
-            const aiElementNames = newParamsList.has('aiElementName') ? newParamsList.get('aiElementName') : [];
+            const customElements = newParamsList.has('customElement')
+                ? newParamsList.get('customElement')
+                : [];
+            const aiElementNames = newParamsList.has('aiElementName')
+                ? newParamsList.get('aiElementName')
+                : [];
             return getter.getterExecutor(newCurrentInstruction.trim(), {
                 customElementsJson: customElements,
                 aiElementNames,
@@ -59,8 +62,12 @@ class FluentBase {
         }
         return this.prev.getterStringBuilder(newCurrentInstruction, newParamsList);
     }
-    get textStr() { return this._textStr; }
-    get params() { return this._params; }
+    get textStr() {
+        return this._textStr;
+    }
+    get params() {
+        return this._params;
+    }
 }
 class Exec extends FluentBase {
     exec() {
@@ -208,6 +215,7 @@ class FluentFilters extends FluentBase {
         return new FluentFiltersOrRelations(this);
     }
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelations}
      */
@@ -236,6 +244,8 @@ class FluentFilters extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelations}
      */
     text(text) {
@@ -268,9 +278,9 @@ class FluentFilters extends FluentBase {
         return new FluentFiltersOrRelations(this);
     }
     /**
-     * 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()`.
+     * Filters for a 'custom element', that is a UI element that 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.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -301,7 +311,7 @@ class FluentFilters extends FluentBase {
      * - **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' | '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'.
+     *     - 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.
@@ -316,7 +326,13 @@ class FluentFilters extends FluentBase {
         return new FluentFiltersOrRelations(this);
     }
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -404,13 +420,13 @@ class FluentFilters extends FluentBase {
      * '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
+     * '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-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelations}
      */
@@ -514,9 +530,13 @@ class FluentFilters extends FluentBase {
      * 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 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.
+     * **Important: _Matching only returns the best matching element when you use it with `get()`_**
+     *
+     * A bit of playing around to find a matching description is sometimes needed:
+     * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
+     * Generally, the more detail the better.
+     *
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -689,7 +709,12 @@ 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)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -707,21 +732,32 @@ class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    rightOf(optionalIndex = 0) {
+    rightOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' right';
         this._textStr += ' of';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFilters(this);
     }
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -739,21 +775,32 @@ class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    leftOf(optionalIndex = 0) {
+    leftOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' left';
         this._textStr += ' of';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFilters(this);
     }
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -777,20 +824,31 @@ class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    below(optionalIndex = 0) {
+    below(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' below';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFilters(this);
     }
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -814,14 +872,20 @@ class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    above(optionalIndex = 0) {
+    above(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' above';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFilters(this);
     }
     /**
@@ -1027,6 +1091,7 @@ class FluentFiltersCondition extends FluentBase {
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
@@ -1055,6 +1120,8 @@ class FluentFiltersCondition extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     text(text) {
@@ -1087,9 +1154,9 @@ class FluentFiltersCondition extends FluentBase {
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
-     * 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()`.
+     * Filters for a 'custom element', that is a UI element that 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.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -1120,7 +1187,7 @@ class FluentFiltersCondition extends FluentBase {
      * - **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' | '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'.
+     *     - 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.
@@ -1135,7 +1202,13 @@ class FluentFiltersCondition extends FluentBase {
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -1223,13 +1296,13 @@ class FluentFiltersCondition extends FluentBase {
      * '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
+     * '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-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
@@ -1333,9 +1406,13 @@ class FluentFiltersCondition extends FluentBase {
      * 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 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.
+     * **Important: _Matching only returns the best matching element when you use it with `get()`_**
+     *
+     * A bit of playing around to find a matching description is sometimes needed:
+     * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
+     * Generally, the more detail the better.
+     *
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -1508,7 +1585,12 @@ class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
     /**
      * Filters for an element right of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -1526,21 +1608,32 @@ class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    rightOf(optionalIndex = 0) {
+    rightOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' right';
         this._textStr += ' of';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFiltersCondition(this);
     }
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -1558,21 +1651,32 @@ class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    leftOf(optionalIndex = 0) {
+    leftOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' left';
         this._textStr += ' of';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFiltersCondition(this);
     }
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -1596,20 +1700,31 @@ class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    below(optionalIndex = 0) {
+    below(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' below';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFiltersCondition(this);
     }
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -1633,14 +1748,20 @@ class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    above(optionalIndex = 0) {
+    above(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' above';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFiltersCondition(this);
     }
     /**
@@ -2046,7 +2167,7 @@ class FluentCommand extends FluentBase {
         return new Exec(this);
     }
     /**
-     * Executes a shell command on the device your UiController is connected to.
+     * Executes a shell command on the device your AskUI Controller is connected to.
      *
      * **Example:**
      * ```typescript
@@ -2527,6 +2648,7 @@ class FluentFiltersGetter extends FluentBase {
         return new FluentFiltersOrRelationsGetter(this);
     }
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
@@ -2555,6 +2677,8 @@ class FluentFiltersGetter extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelationsGetter}
      */
     text(text) {
@@ -2587,9 +2711,9 @@ class FluentFiltersGetter extends FluentBase {
         return new FluentFiltersOrRelationsGetter(this);
     }
     /**
-     * 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()`.
+     * Filters for a 'custom element', that is a UI element that 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.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -2620,7 +2744,7 @@ class FluentFiltersGetter extends FluentBase {
      * - **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' | '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'.
+     *     - 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.
@@ -2635,7 +2759,13 @@ class FluentFiltersGetter extends FluentBase {
         return new FluentFiltersOrRelationsGetter(this);
     }
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -2723,13 +2853,13 @@ class FluentFiltersGetter extends FluentBase {
      * '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
+     * '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-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
@@ -2833,9 +2963,13 @@ class FluentFiltersGetter extends FluentBase {
      * 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 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.
+     * **Important: _Matching only returns the best matching element when you use it with `get()`_**
+     *
+     * A bit of playing around to find a matching description is sometimes needed:
+     * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
+     * Generally, the more detail the better.
+     *
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -3008,7 +3142,12 @@ 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)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -3026,21 +3165,32 @@ class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    rightOf(optionalIndex = 0) {
+    rightOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' right';
         this._textStr += ' of';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFiltersGetter(this);
     }
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -3058,21 +3208,32 @@ class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    leftOf(optionalIndex = 0) {
+    leftOf(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' left';
         this._textStr += ' of';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFiltersGetter(this);
     }
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -3096,20 +3257,31 @@ class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    below(optionalIndex = 0) {
+    below(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' below';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFiltersGetter(this);
     }
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -3133,14 +3305,20 @@ class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    above(optionalIndex = 0) {
+    above(index = 0, intersection_area = 'element_edge_area') {
         this._textStr = '';
-        if (optionalIndex !== undefined) {
-            this._textStr += `index ${optionalIndex}`;
+        if (index !== undefined) {
+            this._textStr += `index ${index}`;
         }
         this._textStr += ' above';
+        if (intersection_area !== undefined) {
+            this._textStr += ` intersection_area ${intersection_area}`;
+        }
         return new FluentFiltersGetter(this);
     }
     /**
@@ -3202,10 +3380,10 @@ class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {
         return new FluentFiltersGetter(this);
     }
     /**
-    * Returns a list of detected elements
-    *
-    * @return {DetectedElement[]}
-    */
+     * Returns a list of detected elements
+     *
+     * @return {DetectedElement[]}
+     */
     exec() {
         return this.getterStringBuilder();
     }
@@ -3222,6 +3400,9 @@ class Getter extends FluentCommand {
      *
      * **Examples:**
      * ```typescript
+     * // ************************************ //
+     * // Log the DetectedElements completely  //
+     * // ************************************ //
      * const text = await aui.get().text('Sign').exec();
      * console.log(text);
      *
@@ -3240,6 +3421,7 @@ class Getter extends FluentCommand {
      * ]
      * ```
      *
+     * ```typescript
      * // *************************************************** //
      * // Examples on how to work with the returned elements  //
      * // *************************************************** //
@@ -3323,6 +3505,7 @@ class Getter extends FluentCommand {
      *         xmax: 1178.8204241071428,
      *         ymax: 180.83512834821428
      *      },
+     *   },
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'search',
@@ -3332,8 +3515,8 @@ class Getter extends FluentCommand {
      *         xmax: 450.6304241071428,
      *         ymax: 950.47812834821428
      *      },
-     *      ... 381 more items
-     *    }
+     *    },
+     *   ... 381 more items
      *  ]
      * ```
      *