askui 0.21.2 → 0.23.0

package/dist/esm/execution/dsl.js

@@ -192,46 +192,6 @@ export class FluentFilters extends FluentBase {
         this._textStr += 'button';
         return new FluentFiltersOrRelations(this);
     }
-    /**
-     *
-     * @param {number} index - element index
-     *
-     * @return {FluentFiltersOrRelations}
-     */
-    row(index) {
-        this._textStr = '';
-        this._textStr += 'row';
-        this._textStr += ` ${index}`;
-        return new FluentFiltersOrRelations(this);
-    }
-    /**
-     *
-     * @param {number} index - element index
-     *
-     * @return {FluentFiltersOrRelations}
-     */
-    column(index) {
-        this._textStr = '';
-        this._textStr += 'column';
-        this._textStr += ` ${index}`;
-        return new FluentFiltersOrRelations(this);
-    }
-    /**
-     *
-     * @param {number} row_index - row index
-     * @param {number} column_index - column index
-     *
-     * @return {FluentFiltersOrRelations}
-     */
-    cell(row_index, column_index) {
-        this._textStr = '';
-        this._textStr += 'cell';
-        this._textStr += ' row';
-        this._textStr += ` ${row_index}`;
-        this._textStr += ' column';
-        this._textStr += ` ${column_index}`;
-        return new FluentFiltersOrRelations(this);
-    }
     /**
      * Filters for a UI element 'table'.
      *
@@ -576,47 +536,6 @@ export class FluentFilters extends FluentBase {
         this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
         return new FluentFiltersOrRelations(this);
     }
-    /**
-     * 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.
-     *
-     * **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:
-     * For example, `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
-     * // Select the black sneaker from a bunch of sneakers
-     * await aui.click().element().matching('a black sneaker shoe').exec();
-     *
-     * // Select an image that has text in it
-     * await aui.click().element().matching('has Burger King in it').exec();
-     * await aui.click().element().matching('has adidas in it').exec();
-     *
-     * // Target a logo/image by describing it
-     * await aui.click().element().matching('a mask on purple background and a firefox logo').exec();
-     * await aui.click().element().matching('logo looking like an apple with one bite bitten off').exec();
-     * await aui.click().element().matching('logo looking like a seashell').exec();
-     * ```
-     *
-     * @param {string} text - A description of the target element.
-     *
-     * @return {FluentFiltersOrRelations}
-     */
-    matching(text) {
-        this._textStr = '';
-        this._textStr += 'matching';
-        this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
-        return new FluentFiltersOrRelations(this);
-    }
 }
 // Relations
 export class FluentFiltersOrRelations extends FluentFilters {
@@ -1226,46 +1145,6 @@ export class FluentFiltersCondition extends FluentBase {
         this._textStr += 'button';
         return new FluentFiltersOrRelationsCondition(this);
     }
-    /**
-     *
-     * @param {number} index - element index
-     *
-     * @return {FluentFiltersOrRelationsCondition}
-     */
-    row(index) {
-        this._textStr = '';
-        this._textStr += 'row';
-        this._textStr += ` ${index}`;
-        return new FluentFiltersOrRelationsCondition(this);
-    }
-    /**
-     *
-     * @param {number} index - element index
-     *
-     * @return {FluentFiltersOrRelationsCondition}
-     */
-    column(index) {
-        this._textStr = '';
-        this._textStr += 'column';
-        this._textStr += ` ${index}`;
-        return new FluentFiltersOrRelationsCondition(this);
-    }
-    /**
-     *
-     * @param {number} row_index - row index
-     * @param {number} column_index - column index
-     *
-     * @return {FluentFiltersOrRelationsCondition}
-     */
-    cell(row_index, column_index) {
-        this._textStr = '';
-        this._textStr += 'cell';
-        this._textStr += ' row';
-        this._textStr += ` ${row_index}`;
-        this._textStr += ' column';
-        this._textStr += ` ${column_index}`;
-        return new FluentFiltersOrRelationsCondition(this);
-    }
     /**
      * Filters for a UI element 'table'.
      *
@@ -1610,47 +1489,6 @@ export class FluentFiltersCondition extends FluentBase {
         this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
         return new FluentFiltersOrRelationsCondition(this);
     }
-    /**
-     * 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.
-     *
-     * **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:
-     * For example, `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
-     * // Select the black sneaker from a bunch of sneakers
-     * await aui.click().element().matching('a black sneaker shoe').exec();
-     *
-     * // Select an image that has text in it
-     * await aui.click().element().matching('has Burger King in it').exec();
-     * await aui.click().element().matching('has adidas in it').exec();
-     *
-     * // Target a logo/image by describing it
-     * await aui.click().element().matching('a mask on purple background and a firefox logo').exec();
-     * await aui.click().element().matching('logo looking like an apple with one bite bitten off').exec();
-     * await aui.click().element().matching('logo looking like a seashell').exec();
-     * ```
-     *
-     * @param {string} text - A description of the target element.
-     *
-     * @return {FluentFiltersOrRelationsCondition}
-     */
-    matching(text) {
-        this._textStr = '';
-        this._textStr += 'matching';
-        this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
-        return new FluentFiltersOrRelationsCondition(this);
-    }
 }
 // Relations
 export class FluentFiltersOrRelationsCondition extends FluentFiltersCondition {
@@ -2941,46 +2779,6 @@ export class FluentFiltersGetter extends FluentBase {
         this._textStr += 'button';
         return new FluentFiltersOrRelationsGetter(this);
     }
-    /**
-     *
-     * @param {number} index - element index
-     *
-     * @return {FluentFiltersOrRelationsGetter}
-     */
-    row(index) {
-        this._textStr = '';
-        this._textStr += 'row';
-        this._textStr += ` ${index}`;
-        return new FluentFiltersOrRelationsGetter(this);
-    }
-    /**
-     *
-     * @param {number} index - element index
-     *
-     * @return {FluentFiltersOrRelationsGetter}
-     */
-    column(index) {
-        this._textStr = '';
-        this._textStr += 'column';
-        this._textStr += ` ${index}`;
-        return new FluentFiltersOrRelationsGetter(this);
-    }
-    /**
-     *
-     * @param {number} row_index - row index
-     * @param {number} column_index - column index
-     *
-     * @return {FluentFiltersOrRelationsGetter}
-     */
-    cell(row_index, column_index) {
-        this._textStr = '';
-        this._textStr += 'cell';
-        this._textStr += ' row';
-        this._textStr += ` ${row_index}`;
-        this._textStr += ' column';
-        this._textStr += ` ${column_index}`;
-        return new FluentFiltersOrRelationsGetter(this);
-    }
     /**
      * Filters for a UI element 'table'.
      *
@@ -3325,47 +3123,6 @@ export class FluentFiltersGetter extends FluentBase {
         this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
         return new FluentFiltersOrRelationsGetter(this);
     }
-    /**
-     * 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.
-     *
-     * **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:
-     * For example, `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
-     * // Select the black sneaker from a bunch of sneakers
-     * await aui.click().element().matching('a black sneaker shoe').exec();
-     *
-     * // Select an image that has text in it
-     * await aui.click().element().matching('has Burger King in it').exec();
-     * await aui.click().element().matching('has adidas in it').exec();
-     *
-     * // Target a logo/image by describing it
-     * await aui.click().element().matching('a mask on purple background and a firefox logo').exec();
-     * await aui.click().element().matching('logo looking like an apple with one bite bitten off').exec();
-     * await aui.click().element().matching('logo looking like a seashell').exec();
-     * ```
-     *
-     * @param {string} text - A description of the target element.
-     *
-     * @return {FluentFiltersOrRelationsGetter}
-     */
-    matching(text) {
-        this._textStr = '';
-        this._textStr += 'matching';
-        this._textStr += ` ${Separators.STRING}${text}${Separators.STRING}`;
-        return new FluentFiltersOrRelationsGetter(this);
-    }
 }
 // Relations
 export class FluentFiltersOrRelationsGetter extends FluentFiltersGetter {

package/dist/esm/execution/inference-client.js

@@ -15,7 +15,7 @@ import { InferenceResponseError } from './inference-response-error';
 import { ConfigurationError } from './config-error';
 import { logger } from '../lib/logger';
 export class InferenceClient {
-    constructor(baseUrl, httpClient, resize, workspaceId, modelComposition, apiVersion = 'v3') {
+    constructor(baseUrl, httpClient, resize, workspaceId, modelComposition, apiVersion = 'v1') {
         this.baseUrl = baseUrl;
         this.httpClient = httpClient;
         this.resize = resize;

package/dist/esm/execution/ui-control-client-dependency-builder.js

@@ -53,10 +53,13 @@ export class UiControlClientDependencyBuilder {
     }
     static getClientArgsWithDefaults(clientArgs) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f;
-            return Object.assign(Object.assign({}, clientArgs), { context: {
-                    isCi: (_b = (_a = clientArgs.context) === null || _a === void 0 ? void 0 : _a.isCi) !== null && _b !== void 0 ? _b : isCI,
-                }, credentials: readCredentials(clientArgs), inferenceServerApiVersion: (_c = clientArgs.inferenceServerApiVersion) !== null && _c !== void 0 ? _c : 'v3', inferenceServerUrl: (_d = clientArgs.inferenceServerUrl) !== null && _d !== void 0 ? _d : 'https://inference.askui.com', proxyAgents: (_e = clientArgs.proxyAgents) !== null && _e !== void 0 ? _e : (yield envProxyAgents()), uiControllerUrl: (_f = clientArgs.uiControllerUrl) !== null && _f !== void 0 ? _f : 'http://127.0.0.1:6769' });
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            return Object.assign(Object.assign({}, clientArgs), { aiElementArgs: {
+                    additionalLocations: (_b = (_a = clientArgs.aiElementArgs) === null || _a === void 0 ? void 0 : _a.additionalLocations) !== null && _b !== void 0 ? _b : [],
+                    onLocationNotExist: (_d = (_c = clientArgs.aiElementArgs) === null || _c === void 0 ? void 0 : _c.onLocationNotExist) !== null && _d !== void 0 ? _d : 'error',
+                }, context: {
+                    isCi: (_f = (_e = clientArgs.context) === null || _e === void 0 ? void 0 : _e.isCi) !== null && _f !== void 0 ? _f : isCI,
+                }, credentials: readCredentials(clientArgs), inferenceServerApiVersion: (_g = clientArgs.inferenceServerApiVersion) !== null && _g !== void 0 ? _g : 'v3', inferenceServerUrl: (_h = clientArgs.inferenceServerUrl) !== null && _h !== void 0 ? _h : 'https://inference.askui.com', proxyAgents: (_j = clientArgs.proxyAgents) !== null && _j !== void 0 ? _j : (yield envProxyAgents()), uiControllerUrl: (_k = clientArgs.uiControllerUrl) !== null && _k !== void 0 ? _k : 'http://127.0.0.1:6769' });
         });
     }
 }

package/dist/esm/execution/ui-control-client.d.ts

@@ -32,6 +32,7 @@ export declare class UiControlClient extends ApiCommands {
     private workspaceId;
     private executionRuntime;
     private stepReporter;
+    private aiElementArgs;
     private constructor();
     static build(clientArgs?: ClientArgs): Promise<UiControlClient>;
     /**
@@ -243,12 +244,6 @@ export declare class UiControlClient extends ApiCommands {
      * @param {string} label - The textfields label.
      */
     clickTextfieldNearestTo(label: string): Promise<void>;
-    /**
-     * Clicks an icon based on a description.
-     *
-     * @param {string} description
-     */
-    clickIcon(description: string): Promise<void>;
     /**
      * Wait until an AskUICommand does not fail.
      *

package/dist/esm/execution/ui-control-client.js

@@ -15,11 +15,12 @@ import { logger } from '../lib/logger';
 import { UiControlClientDependencyBuilder } from './ui-control-client-dependency-builder';
 import { AIElementCollection } from '../core/ai-element/ai-element-collection';
 export class UiControlClient extends ApiCommands {
-    constructor(workspaceId, executionRuntime, stepReporter) {
+    constructor(workspaceId, executionRuntime, stepReporter, aiElementArgs) {
         super();
         this.workspaceId = workspaceId;
         this.executionRuntime = executionRuntime;
         this.stepReporter = stepReporter;
+        this.aiElementArgs = aiElementArgs;
         this.secretText = undefined;
     }
     static build() {
@@ -27,7 +28,7 @@ export class UiControlClient extends ApiCommands {
             const builder = UiControlClientDependencyBuilder;
             const clientArgsWithDefaults = yield builder.getClientArgsWithDefaults(clientArgs);
             const { workspaceId, executionRuntime, stepReporter, } = yield builder.build(clientArgsWithDefaults);
-            return new UiControlClient(workspaceId, executionRuntime, stepReporter);
+            return new UiControlClient(workspaceId, executionRuntime, stepReporter, clientArgsWithDefaults.aiElementArgs);
         });
     }
     /**
@@ -127,7 +128,7 @@ export class UiControlClient extends ApiCommands {
                 return [];
             }
             // eslint-disable-next-line max-len
-            const workspaceAIElementCollection = yield AIElementCollection.collectForWorkspaceId(this.workspaceId);
+            const workspaceAIElementCollection = yield AIElementCollection.collectAIElements(this.workspaceId, this.aiElementArgs);
             return workspaceAIElementCollection.getByNames(names);
         });
     }
@@ -406,16 +407,6 @@ export class UiControlClient extends ApiCommands {
                 .exec();
         });
     }
-    /**
-     * Clicks an icon based on a description.
-     *
-     * @param {string} description
-     */
-    clickIcon(description) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.click().icon().matching(description).exec();
-        });
-    }
     /**
      * Wait until an AskUICommand does not fail.
      *

package/dist/esm/execution/ui-controller-client-interface.d.ts

@@ -4,6 +4,7 @@ import { ModelCompositionBranch } from './model-composition-branch';
 import { Reporter } from '../core/reporting';
 import { Context } from './context';
 import { RetryStrategy } from './retry-strategies/retry-strategy';
+import { AIElementArgs } from '../core/ai-element/ai-elements-args';
 /**
  * Context object to provide additional information about the context of (test) automation.
  *
@@ -47,6 +48,8 @@ export interface ContextArgs {
  * @property {(RetryStrategy | undefined)} [retryStrategy] - Default: `new LinearRetryStrategy()`.
  *    Strategy for retrying failed requests to the inference server. This can help manage transient
  *    errors or network issues, improving the reliability of interactions with the server.
+ * @property {AIElementArgs} [aiElementArgs] - Options for configuring how AI elements are
+ *   collected.
  */
 export interface ClientArgs {
     readonly uiControllerUrl?: string;
@@ -59,11 +62,13 @@ export interface ClientArgs {
     readonly context?: ContextArgs | undefined;
     readonly inferenceServerApiVersion?: string;
     readonly retryStrategy?: RetryStrategy;
+    readonly aiElementArgs?: AIElementArgs;
 }
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;
     readonly inferenceServerUrl: string;
     readonly context: Context;
     readonly inferenceServerApiVersion: string;
+    readonly aiElementArgs: AIElementArgs;
     readonly retryStrategy?: RetryStrategy;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.21.2",
+    "version": "0.23.0",
     "license": "MIT",
     "author": "askui GmbH <info@askui.com> (http://www.askui.com/)",
     "description": "Reliable, automated end-to-end-testing that depends on what is shown on your screen instead of the technology you are running on",