askui 0.10.2 → 0.10.3

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

@@ -32,12 +32,6 @@ export declare class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     otherElement(): FluentFiltersOrRelations;
-    /**
-     * Filters for a UI element 'table'.
-     *
-     * @return {FluentFiltersOrRelations}
-     */
-    table(): FluentFiltersOrRelations;
     /**
      * Filters for a UI element 'switch'.
      *
@@ -68,7 +62,13 @@ export declare class FluentFilters extends FluentBase {
      */
     element(): FluentFiltersOrRelations;
     /**
-     * Filters special elements
+     * Filters special elements defined over a specifically trained custom element descriptor.
+     *
+     * Custom element descriptors are trained on your elements that were not detected with our
+     * default models. Please contact us for further details on how to do this. We are working on
+     * a solution to provide this in our User Portal.
+     *
+     * In the example below circle refers to a circle shaped icon with specific properties.
      *
      * **Examples:**
      * ```typescript
@@ -91,6 +91,25 @@ export declare class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     button(): FluentFiltersOrRelations;
+    /**
+     *
+     * @param {number} index - element index
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    row(index: number): FluentFiltersOrRelations;
+    /**
+     *
+     * @param {number} index - element index
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    col(index: number): FluentFiltersOrRelations;
+    /**
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    table(): FluentFiltersOrRelations;
     /**
      * Filters for an UI element 'text'.
      *
@@ -106,7 +125,7 @@ export declare class FluentFilters extends FluentBase {
      *
      * @return {FluentFiltersOrRelations}
      */
-    text(): FluentFiltersOrRelations;
+    text(text: string | undefined): FluentFiltersOrRelations;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -274,6 +293,19 @@ export declare class FluentFilters extends FluentBase {
     /**
      * Filters elements based on a textual description.
      *
+     * ## 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.
+     * Generally the more detail the better.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.click().matching('a mask on purple background and a firefox logo').exec()
+     * ```
+     *
      * @param {string} text - A description of the target element.
      *
      * @return {FluentFiltersOrRelations}
@@ -426,7 +458,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    rightOf(): FluentFilters;
+    rightOf(optionalIndex?: number | undefined): FluentFilters;
     /**
      * Filters for an element left of another element.
      *
@@ -445,7 +477,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    leftOf(): FluentFilters;
+    leftOf(optionalIndex?: number | undefined): FluentFilters;
     /**
      * Filters for an element below another element.
      *
@@ -467,7 +499,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    below(): FluentFilters;
+    below(optionalIndex?: number | undefined): FluentFilters;
     /**
      * Filters for an element above another element.
      *
@@ -489,7 +521,7 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      *
      * @return {FluentFilters}
      */
-    above(): FluentFilters;
+    above(optionalIndex?: number | undefined): FluentFilters;
     /**
      * Filters for an element nearest to another element.
      *
@@ -548,12 +580,6 @@ export declare class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     otherElement(): FluentFiltersOrRelationsCondition;
-    /**
-     * Filters for a UI element 'table'.
-     *
-     * @return {FluentFiltersOrRelationsCondition}
-     */
-    table(): FluentFiltersOrRelationsCondition;
     /**
      * Filters for a UI element 'switch'.
      *
@@ -584,7 +610,13 @@ export declare class FluentFiltersCondition extends FluentBase {
      */
     element(): FluentFiltersOrRelationsCondition;
     /**
-     * Filters special elements
+     * Filters special elements defined over a specifically trained custom element descriptor.
+     *
+     * Custom element descriptors are trained on your elements that were not detected with our
+     * default models. Please contact us for further details on how to do this. We are working on
+     * a solution to provide this in our User Portal.
+     *
+     * In the example below circle refers to a circle shaped icon with specific properties.
      *
      * **Examples:**
      * ```typescript
@@ -607,6 +639,25 @@ export declare class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     button(): FluentFiltersOrRelationsCondition;
+    /**
+     *
+     * @param {number} index - element index
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    row(index: number): FluentFiltersOrRelationsCondition;
+    /**
+     *
+     * @param {number} index - element index
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    col(index: number): FluentFiltersOrRelationsCondition;
+    /**
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    table(): FluentFiltersOrRelationsCondition;
     /**
      * Filters for an UI element 'text'.
      *
@@ -622,7 +673,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
-    text(): FluentFiltersOrRelationsCondition;
+    text(text: string | undefined): FluentFiltersOrRelationsCondition;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -790,6 +841,19 @@ export declare class FluentFiltersCondition extends FluentBase {
     /**
      * Filters elements based on a textual description.
      *
+     * ## 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.
+     * Generally the more detail the better.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.click().matching('a mask on purple background and a firefox logo').exec()
+     * ```
+     *
      * @param {string} text - A description of the target element.
      *
      * @return {FluentFiltersOrRelationsCondition}
@@ -942,7 +1006,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    rightOf(): FluentFiltersCondition;
+    rightOf(optionalIndex?: number | undefined): FluentFiltersCondition;
     /**
      * Filters for an element left of another element.
      *
@@ -961,7 +1025,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    leftOf(): FluentFiltersCondition;
+    leftOf(optionalIndex?: number | undefined): FluentFiltersCondition;
     /**
      * Filters for an element below another element.
      *
@@ -983,7 +1047,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    below(): FluentFiltersCondition;
+    below(optionalIndex?: number | undefined): FluentFiltersCondition;
     /**
      * Filters for an element above another element.
      *
@@ -1005,7 +1069,7 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      *
      * @return {FluentFiltersCondition}
      */
-    above(): FluentFiltersCondition;
+    above(optionalIndex?: number | undefined): FluentFiltersCondition;
     /**
      * Filters for an element nearest to another element.
      *
@@ -1111,7 +1175,7 @@ export declare abstract class FluentCommand extends FluentBase {
     /**
      * Expects a condition, e.g., `exists()` or `notExits()`.
      *
-     * Use the structure `expect().<your filter>.(exists()|notExists()` as shown in the examples below.
+     * Use the structure `expect().<your filter>.(exists()|notExists())` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -1509,12 +1573,6 @@ export declare class FluentFiltersGetter extends FluentBase {
      * @return {FluentFiltersOrRelationsGetter}
      */
     otherElement(): FluentFiltersOrRelationsGetter;
-    /**
-     * Filters for a UI element 'table'.
-     *
-     * @return {FluentFiltersOrRelationsGetter}
-     */
-    table(): FluentFiltersOrRelationsGetter;
     /**
      * Filters for a UI element 'switch'.
      *
@@ -1545,7 +1603,13 @@ export declare class FluentFiltersGetter extends FluentBase {
      */
     element(): FluentFiltersOrRelationsGetter;
     /**
-     * Filters special elements
+     * Filters special elements defined over a specifically trained custom element descriptor.
+     *
+     * Custom element descriptors are trained on your elements that were not detected with our
+     * default models. Please contact us for further details on how to do this. We are working on
+     * a solution to provide this in our User Portal.
+     *
+     * In the example below circle refers to a circle shaped icon with specific properties.
      *
      * **Examples:**
      * ```typescript
@@ -1568,6 +1632,25 @@ export declare class FluentFiltersGetter extends FluentBase {
      * @return {FluentFiltersOrRelationsGetter}
      */
     button(): FluentFiltersOrRelationsGetter;
+    /**
+     *
+     * @param {number} index - element index
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    row(index: number): FluentFiltersOrRelationsGetter;
+    /**
+     *
+     * @param {number} index - element index
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    col(index: number): FluentFiltersOrRelationsGetter;
+    /**
+     *
+     * @return {FluentFiltersOrRelationsGetter}
+     */
+    table(): FluentFiltersOrRelationsGetter;
     /**
      * Filters for an UI element 'text'.
      *
@@ -1583,7 +1666,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
-    text(): FluentFiltersOrRelationsGetter;
+    text(text: string | undefined): FluentFiltersOrRelationsGetter;
     /**
      * Filters for a UI element 'icon'.
      *
@@ -1751,6 +1834,19 @@ export declare class FluentFiltersGetter extends FluentBase {
     /**
      * Filters elements based on a textual description.
      *
+     * ## 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.
+     * Generally the more detail the better.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.click().matching('a mask on purple background and a firefox logo').exec()
+     * ```
+     *
      * @param {string} text - A description of the target element.
      *
      * @return {FluentFiltersOrRelationsGetter}
@@ -1903,7 +1999,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    rightOf(): FluentFiltersGetter;
+    rightOf(optionalIndex?: number | undefined): FluentFiltersGetter;
     /**
      * Filters for an element left of another element.
      *
@@ -1922,7 +2018,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    leftOf(): FluentFiltersGetter;
+    leftOf(optionalIndex?: number | undefined): FluentFiltersGetter;
     /**
      * Filters for an element below another element.
      *
@@ -1944,7 +2040,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    below(): FluentFiltersGetter;
+    below(optionalIndex?: number | undefined): FluentFiltersGetter;
     /**
      * Filters for an element above another element.
      *
@@ -1966,7 +2062,7 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      *
      * @return {FluentFiltersGetter}
      */
-    above(): FluentFiltersGetter;
+    above(optionalIndex?: number | undefined): FluentFiltersGetter;
     /**
      * Filters for an element nearest to another element.
      *