askui 0.21.2 → 0.22.0

package/dist/cjs/core/ai-element/ai-element-collection.d.ts

@@ -1,10 +1,12 @@
 import { AIElement } from './ai-element';
 import { CustomElementJson } from '../model/custom-element-json';
+import { AIElementArgs } from './ai-elements-args';
 export declare class AIElementCollection {
     private elements;
     static AI_ELEMENT_FOLDER: string;
     constructor(elements: AIElement[]);
-    static collectForWorkspaceId(workspaceId: string | undefined): Promise<AIElementCollection>;
+    static collectAIElements(workspaceId: string | undefined, aiElementArgs: AIElementArgs): Promise<AIElementCollection>;
     getByName(name: string): CustomElementJson[];
     getByNames(names: string[]): CustomElementJson[];
+    private static CollectAiElementsFromLocation;
 }

package/dist/cjs/core/ai-element/ai-element-collection.js

@@ -23,37 +23,37 @@ class AIElementCollection {
     constructor(elements) {
         this.elements = elements;
     }
-    static collectForWorkspaceId(workspaceId) {
+    static collectAIElements(workspaceId, aiElementArgs) {
         return __awaiter(this, void 0, void 0, function* () {
-            lib_1.logger.debug(`Collecting AIElements for workspace '${workspaceId}' ...`);
-            if (workspaceId === undefined) {
+            if (!workspaceId) {
                 throw new ai_element_error_1.AIElementError("Value of 'workspaceId' must be defined.");
             }
             const workspaceAIElementFolder = path_1.default.join(AIElementCollection.AI_ELEMENT_FOLDER, workspaceId);
-            if (!(yield fs_extra_1.default.pathExists(workspaceAIElementFolder))) {
-                throw new ai_element_error_1.AIElementError(`Missing AIElement folder for workspace '${workspaceId}' at '${workspaceAIElementFolder}'.`);
-            }
-            const files = yield fs_extra_1.default.readdir(workspaceAIElementFolder);
-            if (files.length === 0) {
-                throw new ai_element_error_1.AIElementError(`'${workspaceAIElementFolder}' is empty. No AIElement files found for workspace '${workspaceId}'.`);
-            }
-            const aiElements = yield Promise.all(files
-                .filter((file) => path_1.default.extname(file) === '.json')
-                .map((file) => __awaiter(this, void 0, void 0, function* () {
-                const jsonFile = path_1.default.join(workspaceAIElementFolder, file);
-                const baseName = path_1.default.basename(jsonFile, '.json');
-                const pngFile = path_1.default.join(workspaceAIElementFolder, `${baseName}.png`);
-                if (yield fs_extra_1.default.pathExists(pngFile)) {
-                    const metadata = JSON.parse(yield fs_extra_1.default.readFile(jsonFile, 'utf-8'));
-                    return ai_element_1.AIElement.fromJson(metadata, pngFile);
+            const aiElementsLocations = [
+                workspaceAIElementFolder,
+                ...aiElementArgs.additionalLocations.map((userPath) => path_1.default.resolve(userPath)),
+            ];
+            const aiElements = [];
+            yield Promise.all(aiElementsLocations.map((aiElementLocation) => __awaiter(this, void 0, void 0, function* () {
+                if (yield fs_extra_1.default.pathExists(aiElementLocation)) {
+                    aiElements.push(...AIElementCollection.CollectAiElementsFromLocation(aiElementLocation));
+                }
+                else {
+                    const errorMessage = `AIElements location '${aiElementLocation}' does not exist.`;
+                    if (aiElementArgs.onLocationNotExist === 'error') {
+                        throw new ai_element_error_1.AIElementError(errorMessage);
+                    }
+                    else if (aiElementArgs.onLocationNotExist === 'warn') {
+                        lib_1.logger.warn(errorMessage);
+                    }
                 }
-                return null;
             })));
-            const validAIElements = aiElements.filter((element) => element !== null);
-            if (validAIElements.length === 0) {
-                throw new ai_element_error_1.AIElementError(`No AIElement files found for workspace '${workspaceId}' at '${workspaceAIElementFolder}'.`);
+            if (aiElements.length === 0) {
+                const formattedLocations = aiElementsLocations.map((aiElementsLocation) => `"${aiElementsLocation}"`).join(', ');
+                const errorMessage = `No AIElements found in the following location${aiElementsLocations.length > 1 ? 's' : ''}: [${formattedLocations}].`;
+                throw new ai_element_error_1.AIElementError(errorMessage);
             }
-            return new AIElementCollection(validAIElements);
+            return new AIElementCollection(aiElements);
         });
     }
     getByName(name) {
@@ -73,6 +73,29 @@ class AIElementCollection {
         }
         return names.flatMap((name) => this.getByName(name));
     }
+    static CollectAiElementsFromLocation(aiElementLocation) {
+        const files = fs_extra_1.default.readdirSync(aiElementLocation);
+        if (files.length === 0) {
+            return [];
+        }
+        const aiElements = files
+            .filter((file) => path_1.default.extname(file) === '.json')
+            .map((file) => {
+            const jsonFile = path_1.default.join(aiElementLocation, file);
+            const baseName = path_1.default.basename(jsonFile, '.json');
+            const pngFile = path_1.default.join(aiElementLocation, `${baseName}.png`);
+            if (fs_extra_1.default.existsSync(pngFile)) {
+                const metadata = JSON.parse(fs_extra_1.default.readFileSync(jsonFile, 'utf-8'));
+                return ai_element_1.AIElement.fromJson(metadata, pngFile);
+            }
+            return null;
+        });
+        const validAIElements = aiElements.filter((element) => element !== null);
+        if (validAIElements.length === 0) {
+            lib_1.logger.debug(`No valid AIElements found in '${aiElementLocation}'.`);
+        }
+        return validAIElements;
+    }
 }
 exports.AIElementCollection = AIElementCollection;
 AIElementCollection.AI_ELEMENT_FOLDER = path_1.default.join(os_1.default.homedir(), '.askui', 'SnippingTool', 'AIElement');

package/dist/cjs/core/ai-element/ai-elements-args.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Options for configuring how AI elements are collected.
+ *
+ * @interface AIElementArgs
+ *
+ * @property {string[]} additionalLocations - Additional directories to search for AI elements.
+ *  These directories will be checked for the presence of AI element files.
+ *
+ * @property {'Warn' | 'Error' | 'Ignore'} onLocationNotExist - Action to take when
+ *  one or more specified directories do not exist.
+ *      - `'warn'` → Logs a warning if a directory is missing.
+ *      - `'error'` → Throws an error if a directory is missing.
+ *      - `'igone'` → Skips missing directories without logging anything.
+ *  This action is triggered when specified directories do not exist,
+ *      not when AI elements within those directories are missing.
+ */
+export interface AIElementArgs {
+    additionalLocations: string[];
+    onLocationNotExist?: 'warn' | 'error' | 'ignore';
+}

package/dist/cjs/core/ai-element/ai-elements-args.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -59,10 +59,13 @@ 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 : is_ci_1.default,
-                }, credentials: (0, read_credentials_1.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 (0, proxy_builder_1.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 : is_ci_1.default,
+                }, credentials: (0, read_credentials_1.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 (0, proxy_builder_1.envProxyAgents)()), uiControllerUrl: (_k = clientArgs.uiControllerUrl) !== null && _k !== void 0 ? _k : 'http://127.0.0.1:6769' });
         });
     }
 }

package/dist/cjs/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>;
     /**

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

@@ -18,11 +18,12 @@ const logger_1 = require("../lib/logger");
 const ui_control_client_dependency_builder_1 = require("./ui-control-client-dependency-builder");
 const ai_element_collection_1 = require("../core/ai-element/ai-element-collection");
 class UiControlClient extends dsl_1.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() {
@@ -30,7 +31,7 @@ class UiControlClient extends dsl_1.ApiCommands {
             const builder = ui_control_client_dependency_builder_1.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);
         });
     }
     /**
@@ -130,7 +131,7 @@ class UiControlClient extends dsl_1.ApiCommands {
                 return [];
             }
             // eslint-disable-next-line max-len
-            const workspaceAIElementCollection = yield ai_element_collection_1.AIElementCollection.collectForWorkspaceId(this.workspaceId);
+            const workspaceAIElementCollection = yield ai_element_collection_1.AIElementCollection.collectAIElements(this.workspaceId, this.aiElementArgs);
             return workspaceAIElementCollection.getByNames(names);
         });
     }

package/dist/cjs/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/dist/esm/core/ai-element/ai-element-collection.d.ts

@@ -1,10 +1,12 @@
 import { AIElement } from './ai-element';
 import { CustomElementJson } from '../model/custom-element-json';
+import { AIElementArgs } from './ai-elements-args';
 export declare class AIElementCollection {
     private elements;
     static AI_ELEMENT_FOLDER: string;
     constructor(elements: AIElement[]);
-    static collectForWorkspaceId(workspaceId: string | undefined): Promise<AIElementCollection>;
+    static collectAIElements(workspaceId: string | undefined, aiElementArgs: AIElementArgs): Promise<AIElementCollection>;
     getByName(name: string): CustomElementJson[];
     getByNames(names: string[]): CustomElementJson[];
+    private static CollectAiElementsFromLocation;
 }

package/dist/esm/core/ai-element/ai-element-collection.js

@@ -17,37 +17,37 @@ export class AIElementCollection {
     constructor(elements) {
         this.elements = elements;
     }
-    static collectForWorkspaceId(workspaceId) {
+    static collectAIElements(workspaceId, aiElementArgs) {
         return __awaiter(this, void 0, void 0, function* () {
-            logger.debug(`Collecting AIElements for workspace '${workspaceId}' ...`);
-            if (workspaceId === undefined) {
+            if (!workspaceId) {
                 throw new AIElementError("Value of 'workspaceId' must be defined.");
             }
             const workspaceAIElementFolder = path.join(AIElementCollection.AI_ELEMENT_FOLDER, workspaceId);
-            if (!(yield fs.pathExists(workspaceAIElementFolder))) {
-                throw new AIElementError(`Missing AIElement folder for workspace '${workspaceId}' at '${workspaceAIElementFolder}'.`);
-            }
-            const files = yield fs.readdir(workspaceAIElementFolder);
-            if (files.length === 0) {
-                throw new AIElementError(`'${workspaceAIElementFolder}' is empty. No AIElement files found for workspace '${workspaceId}'.`);
-            }
-            const aiElements = yield Promise.all(files
-                .filter((file) => path.extname(file) === '.json')
-                .map((file) => __awaiter(this, void 0, void 0, function* () {
-                const jsonFile = path.join(workspaceAIElementFolder, file);
-                const baseName = path.basename(jsonFile, '.json');
-                const pngFile = path.join(workspaceAIElementFolder, `${baseName}.png`);
-                if (yield fs.pathExists(pngFile)) {
-                    const metadata = JSON.parse(yield fs.readFile(jsonFile, 'utf-8'));
-                    return AIElement.fromJson(metadata, pngFile);
+            const aiElementsLocations = [
+                workspaceAIElementFolder,
+                ...aiElementArgs.additionalLocations.map((userPath) => path.resolve(userPath)),
+            ];
+            const aiElements = [];
+            yield Promise.all(aiElementsLocations.map((aiElementLocation) => __awaiter(this, void 0, void 0, function* () {
+                if (yield fs.pathExists(aiElementLocation)) {
+                    aiElements.push(...AIElementCollection.CollectAiElementsFromLocation(aiElementLocation));
+                }
+                else {
+                    const errorMessage = `AIElements location '${aiElementLocation}' does not exist.`;
+                    if (aiElementArgs.onLocationNotExist === 'error') {
+                        throw new AIElementError(errorMessage);
+                    }
+                    else if (aiElementArgs.onLocationNotExist === 'warn') {
+                        logger.warn(errorMessage);
+                    }
                 }
-                return null;
             })));
-            const validAIElements = aiElements.filter((element) => element !== null);
-            if (validAIElements.length === 0) {
-                throw new AIElementError(`No AIElement files found for workspace '${workspaceId}' at '${workspaceAIElementFolder}'.`);
+            if (aiElements.length === 0) {
+                const formattedLocations = aiElementsLocations.map((aiElementsLocation) => `"${aiElementsLocation}"`).join(', ');
+                const errorMessage = `No AIElements found in the following location${aiElementsLocations.length > 1 ? 's' : ''}: [${formattedLocations}].`;
+                throw new AIElementError(errorMessage);
             }
-            return new AIElementCollection(validAIElements);
+            return new AIElementCollection(aiElements);
         });
     }
     getByName(name) {
@@ -67,5 +67,28 @@ export class AIElementCollection {
         }
         return names.flatMap((name) => this.getByName(name));
     }
+    static CollectAiElementsFromLocation(aiElementLocation) {
+        const files = fs.readdirSync(aiElementLocation);
+        if (files.length === 0) {
+            return [];
+        }
+        const aiElements = files
+            .filter((file) => path.extname(file) === '.json')
+            .map((file) => {
+            const jsonFile = path.join(aiElementLocation, file);
+            const baseName = path.basename(jsonFile, '.json');
+            const pngFile = path.join(aiElementLocation, `${baseName}.png`);
+            if (fs.existsSync(pngFile)) {
+                const metadata = JSON.parse(fs.readFileSync(jsonFile, 'utf-8'));
+                return AIElement.fromJson(metadata, pngFile);
+            }
+            return null;
+        });
+        const validAIElements = aiElements.filter((element) => element !== null);
+        if (validAIElements.length === 0) {
+            logger.debug(`No valid AIElements found in '${aiElementLocation}'.`);
+        }
+        return validAIElements;
+    }
 }
 AIElementCollection.AI_ELEMENT_FOLDER = path.join(os.homedir(), '.askui', 'SnippingTool', 'AIElement');

package/dist/esm/core/ai-element/ai-elements-args.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Options for configuring how AI elements are collected.
+ *
+ * @interface AIElementArgs
+ *
+ * @property {string[]} additionalLocations - Additional directories to search for AI elements.
+ *  These directories will be checked for the presence of AI element files.
+ *
+ * @property {'Warn' | 'Error' | 'Ignore'} onLocationNotExist - Action to take when
+ *  one or more specified directories do not exist.
+ *      - `'warn'` → Logs a warning if a directory is missing.
+ *      - `'error'` → Throws an error if a directory is missing.
+ *      - `'igone'` → Skips missing directories without logging anything.
+ *  This action is triggered when specified directories do not exist,
+ *      not when AI elements within those directories are missing.
+ */
+export interface AIElementArgs {
+    additionalLocations: string[];
+    onLocationNotExist?: 'warn' | 'error' | 'ignore';
+}

package/dist/esm/core/ai-element/ai-elements-args.js

@@ -0,0 +1 @@
+export {};

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>;
     /**

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);
         });
     }

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.22.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",