askui 0.17.0 → 0.18.0

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

@@ -0,0 +1,12 @@
+/**
+ * Context object to provide additional information about the context of (test) automation.
+ *
+ * @property {boolean} isCi - Default: Determined automatically by https://github.com/watson/is-ci;
+ *    see https://github.com/watson/ci-info#supported-ci-tools for all supported CI tools.
+ *    Can be used for overriding the automatic detection of CI tools, e.g., if not supported by
+ *    `is-ci`, so that AskUI can be optimized for the corresponding environment, e.g., adjusting
+ *    caching behavior.
+ */
+export interface Context {
+    readonly isCi: boolean;
+}

package/dist/cjs/execution/context.js

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

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

@@ -1 +1 @@
-export { UiControlClient } from './ui-control-client';
+export { UiControlClient, RelationsForConvenienceMethods } from './ui-control-client';

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

@@ -8,8 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UiControlClientDependencyBuilder = void 0;
+const is_ci_1 = __importDefault(require("is-ci"));
 const http_client_got_1 = require("../utils/http/http-client-got");
 const ui_controller_client_1 = require("./ui-controller-client");
 const inference_client_1 = require("./inference-client");
@@ -23,7 +27,7 @@ class UiControlClientDependencyBuilder {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const analytics = new analytics_1.Analytics();
-            const analyticsHeaders = yield analytics.getAnalyticsHeaders();
+            const analyticsHeaders = yield analytics.getAnalyticsHeaders(clientArgs.context);
             const analyticsCookies = yield analytics.getAnalyticsCookies();
             return new http_client_got_1.HttpClientGot((_a = clientArgs.credentials) === null || _a === void 0 ? void 0 : _a.token, analyticsHeaders, analyticsCookies, clientArgs.proxyAgents);
         });
@@ -50,9 +54,11 @@ class UiControlClientDependencyBuilder {
         });
     }
     static getClientArgsWithDefaults(clientArgs) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         return __awaiter(this, void 0, void 0, function* () {
-            return Object.assign(Object.assign({}, clientArgs), { credentials: (0, read_credentials_1.readCredentials)(clientArgs), inferenceServerUrl: (_a = clientArgs.inferenceServerUrl) !== null && _a !== void 0 ? _a : 'https://inference.askui.com', proxyAgents: (_b = clientArgs.proxyAgents) !== null && _b !== void 0 ? _b : (yield (0, proxy_builder_1.envProxyAgents)()), uiControllerUrl: (_c = clientArgs.uiControllerUrl) !== null && _c !== void 0 ? _c : 'http://127.0.0.1:6769' });
+            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), inferenceServerUrl: (_c = clientArgs.inferenceServerUrl) !== null && _c !== void 0 ? _c : 'https://inference.askui.com', proxyAgents: (_d = clientArgs.proxyAgents) !== null && _d !== void 0 ? _d : (yield (0, proxy_builder_1.envProxyAgents)()), uiControllerUrl: (_e = clientArgs.uiControllerUrl) !== null && _e !== void 0 ? _e : 'http://127.0.0.1:6769' });
         });
     }
 }

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

@@ -5,6 +5,7 @@ import { Annotation } from '../core/annotation/annotation';
 import { AnnotationRequest } from '../core/model/annotation-result/annotation-interface';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
 import { ClientArgs } from './ui-controller-client-interface';
+export declare type RelationsForConvenienceMethods = 'nearestTo' | 'leftOf' | 'above' | 'rightOf' | 'below' | 'contains';
 export declare class UiControlClient extends ApiCommands {
     private executionRuntime;
     private stepReporter;
@@ -108,12 +109,6 @@ export declare class UiControlClient extends ApiCommands {
      * @param {PC_AND_MODIFIER_KEY[]} keys
      */
     pressKeys(keys: PC_AND_MODIFIER_KEY[]): Promise<void>;
-    /**
-     * Searches for a text element and clicks it when found.
-     *
-     * @param {string} text - A text to be searched.
-     */
-    clickText(text: string): Promise<void>;
     /**
      * Searches for text elements and clicks them
      * one after another when found.
@@ -121,13 +116,6 @@ export declare class UiControlClient extends ApiCommands {
      * @param {string[]} texts - An array of texts to be searched.
      */
     clickTexts(texts: string[]): Promise<void>;
-    /**
-     * Searches for an element of type button
-     * with a label and clicks it when found.
-     *
-     * @param {string} label - The buttons label.
-     */
-    clickButton(label: string): Promise<void>;
     /**
      * Searches for an element of type textfield with a specific placeholder text.
      * If found, clicks it.
@@ -162,4 +150,157 @@ export declare class UiControlClient extends ApiCommands {
      * @param {number} waitTime - Time in milliseconds
      */
     waitUntil(AskUICommand: Executable, maxTry?: number, waitTime?: number): Promise<void>;
+    private evaluateRelation;
+    /**
+     * Click a button with a specific label.
+     * Optional relation identifies the button in relation to another element.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.clickButton({})
+     * await aui.clickButton({label: 'Checkout here'})
+     * await aui.clickButton({relation: {type: 'leftOf', text: 'Choose a ticket'}})
+     * await aui.clickButton({label: 'Click', {relation: {type: 'leftOf', text: 'Choose a ticket'}})
+     * ```
+     *
+     * @param {Object} params - Object containing properties.
+     * @property {string} [params.label] - The text label of the button. Defaults to an empty string.
+     * @property {Object} [params.relation] - Object describing the relationship between
+     *                                        the clicked button and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of relation.
+     * @property {string} params.relation.text - The text element the relation is based on.
+     */
+    clickButton(params: {
+        label?: string;
+        relation?: {
+            type: RelationsForConvenienceMethods;
+            text: string;
+        };
+    }): Promise<void>;
+    /**
+     * Click a checkbox with a specific label.
+     * You can also specify where the label is placed relationally.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.clickCheckbox({label: 'Toggle'})
+     * await aui.clickCheckbox({label: 'Toggle', relation: {type: 'leftOf'}})
+     * ```
+     *
+     * @param {Object} params - Object containing required `label` property and
+     *                          optional `relation` property.
+     * @property {string} params.label - The label for the checkbox.
+     * @property {Object} params.relation - Object describing the relationship between
+     *                                      the clicked checkbox and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of relation.
+     */
+    clickCheckbox(params: {
+        label: string;
+        relation?: {
+            type: RelationsForConvenienceMethods;
+        };
+    }): Promise<void>;
+    /**
+     * Click a switch with a specific label.
+     * You can also specify where the label is placed relationally.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.clickSwitch({label: 'Toggle'})
+     * await aui.clickSwitch({label: 'Toggle', relation: {type: 'leftOf'}})
+     * ```
+     *
+     * @param {Object} params - Object containing required `label` property and
+     *                          optional `relation` property.
+     * @property {string} params.label - The label for the checkbox.
+     * @property {Object} params.relation - Object describing the relationship between
+     *                                      the clicked checkbox and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of relation.
+     */
+    clickSwitch(params: {
+        label: string;
+        relation?: {
+            type: RelationsForConvenienceMethods;
+        };
+    }): Promise<void>;
+    /**
+     * Types a given text into a textfield.
+     * Use a relation to specify how to find
+     * the textfield in relation to a specific label.
+     *
+     * **Examples:**
+     * ```typescript
+     * // Finds the textfield nearest to the label 'Email'
+     * await aui.typeIntoTextfield({textToWrite: 'Hello World', relation: {label: 'Email'}});
+     *
+     * // Finds the textfield above/below a label 'Password'
+     * await aui.typeIntoTextfield(
+     *   {textToWrite: 'Hello World', relation: {type: 'above', label: 'Password'}}
+     * );
+     * await aui.typeIntoTextfield(
+     *   {textToWrite: 'Hello World', relation: {type: 'below', label: 'Password'}}
+     * );
+     *
+     * // If there is no label but a placeholder, the label is contained in the textfield
+     * await aui.typeIntoTextfield(
+     *   {textToWrite: 'Hello World', relation: {type: 'contains', label: 'Enter email'}}
+     * );
+     * ```
+     *
+     * @param {Object} params - Object containing required `textToWrite` property and
+     *                          optional `relation` property.
+     * @property {string} params.textToWrite - The text to be typed into the textfield.
+     * @property {Object} params.relation - Object describing the relationship between the
+     *                                      textfield being interacted with and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of
+     *                                                                   relation, optional.
+     * @property {string} params.relation.label - The label associated with the related
+     *                                            element, optional.
+     */
+    typeIntoTextfield(params: {
+        textToWrite: string;
+        relation: {
+            type?: RelationsForConvenienceMethods;
+            label: string;
+        };
+    }): Promise<void>;
+    /**
+     * Click on a specific text.
+     * You can also use a RegEx or match the text exactly by specifyicing the specific flag.
+     * Use a relation to find the text in relation to a specific text.
+     *
+     * **Examples:**
+     * ```typescript
+     * // Click text that matches exactly
+     * await aui.clickText({text: 'askui', type: 'similar'})
+     *
+     * // Click text that contains 'pie' or 'cake' or 'Pie' or 'Cake'
+     * await aui.clickText({text: '.*([Pp]ie|[Cc]ake).*', type: 'regex'})
+     *
+     * // Click the text 'TERMINAL' that is left of the text 'Ports'
+     * await aui.clickText({
+     *     text: 'TERMINAL',
+     *     type: "exact",
+     *     relation: { type: 'leftOf', text: 'PORTS' }
+     *   })
+     * ```
+     * @param {Object} params - Object containing required `text` property and optional properties
+     *                          for regular expression matching and relation.
+     * @property {string} params.text - The text to be clicked.
+     * @property {string} params.type - Whether the text is matched using similarity,
+     *                                  exact match or a regular expression.
+     * @property {Object} params.relation - Object describing the relationship between the
+     *                                      clicked text and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of relation.
+     * @property {string} params.relation.text - The label or text associated with the
+     *                                           related element or state.
+     */
+    clickText(params: {
+        text: string;
+        type: 'similar' | 'exact' | 'regex';
+        relation?: {
+            type: RelationsForConvenienceMethods;
+            text: string;
+        };
+    }): Promise<void>;
 }

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

@@ -8,8 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UiControlClient = void 0;
+const ValidationError_1 = __importDefault(require("yup/lib/ValidationError"));
 const custom_element_1 = require("../core/model/custom-element");
 const dsl_1 = require("./dsl");
 const annotation_writer_1 = require("../core/annotation/annotation-writer");
@@ -249,16 +253,6 @@ class UiControlClient extends dsl_1.ApiCommands {
             }
         });
     }
-    /**
-     * Searches for a text element and clicks it when found.
-     *
-     * @param {string} text - A text to be searched.
-     */
-    clickText(text) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.click().text(text).exec();
-        });
-    }
     /**
      * Searches for text elements and clicks them
      * one after another when found.
@@ -273,17 +267,6 @@ class UiControlClient extends dsl_1.ApiCommands {
             }
         });
     }
-    /**
-     * Searches for an element of type button
-     * with a label and clicks it when found.
-     *
-     * @param {string} label - The buttons label.
-     */
-    clickButton(label) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.click().button().withText(label).exec();
-        });
-    }
     /**
      * Searches for an element of type textfield with a specific placeholder text.
      * If found, clicks it.
@@ -346,5 +329,220 @@ class UiControlClient extends dsl_1.ApiCommands {
             }
         });
     }
+    // eslint-disable-next-line class-methods-use-this
+    evaluateRelation(command, relation, text) {
+        let commando = command;
+        switch (relation) {
+            case 'nearestTo':
+                commando = command.nearestTo().text(text);
+                break;
+            case 'leftOf':
+                commando = command.leftOf().text(text);
+                break;
+            case 'above':
+                commando = command.above().text(text);
+                break;
+            case 'rightOf':
+                commando = command.rightOf().text(text);
+                break;
+            case 'below':
+                commando = command.below().text(text);
+                break;
+            case 'contains':
+                commando = command.contains().text(text);
+                break;
+            default:
+                throw new ValidationError_1.default('No valid Relation.Type was passed.');
+        }
+        return commando;
+    }
+    /**
+     * Click a button with a specific label.
+     * Optional relation identifies the button in relation to another element.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.clickButton({})
+     * await aui.clickButton({label: 'Checkout here'})
+     * await aui.clickButton({relation: {type: 'leftOf', text: 'Choose a ticket'}})
+     * await aui.clickButton({label: 'Click', {relation: {type: 'leftOf', text: 'Choose a ticket'}})
+     * ```
+     *
+     * @param {Object} params - Object containing properties.
+     * @property {string} [params.label] - The text label of the button. Defaults to an empty string.
+     * @property {Object} [params.relation] - Object describing the relationship between
+     *                                        the clicked button and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of relation.
+     * @property {string} params.relation.text - The text element the relation is based on.
+     */
+    clickButton(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let command = this.click().button();
+            if (params.label) {
+                command = command.withText(params.label);
+            }
+            if (params.relation) {
+                command = this.evaluateRelation(command, params.relation.type, params.relation.text);
+            }
+            yield command.exec();
+        });
+    }
+    /**
+     * Click a checkbox with a specific label.
+     * You can also specify where the label is placed relationally.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.clickCheckbox({label: 'Toggle'})
+     * await aui.clickCheckbox({label: 'Toggle', relation: {type: 'leftOf'}})
+     * ```
+     *
+     * @param {Object} params - Object containing required `label` property and
+     *                          optional `relation` property.
+     * @property {string} params.label - The label for the checkbox.
+     * @property {Object} params.relation - Object describing the relationship between
+     *                                      the clicked checkbox and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of relation.
+     */
+    clickCheckbox(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let command = this.click().checkbox();
+            if (!params.relation) {
+                command = command.nearestTo().text(params.label);
+            }
+            else {
+                command = this.evaluateRelation(command, params.relation.type, params.label);
+            }
+            yield command.exec();
+        });
+    }
+    /**
+     * Click a switch with a specific label.
+     * You can also specify where the label is placed relationally.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.clickSwitch({label: 'Toggle'})
+     * await aui.clickSwitch({label: 'Toggle', relation: {type: 'leftOf'}})
+     * ```
+     *
+     * @param {Object} params - Object containing required `label` property and
+     *                          optional `relation` property.
+     * @property {string} params.label - The label for the checkbox.
+     * @property {Object} params.relation - Object describing the relationship between
+     *                                      the clicked checkbox and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of relation.
+     */
+    clickSwitch(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let command = this.click().switch();
+            if (!params.relation) {
+                command = command.nearestTo().text(params.label);
+            }
+            else {
+                command = this.evaluateRelation(command, params.relation.type, params.label);
+            }
+            yield command.exec();
+        });
+    }
+    /**
+     * Types a given text into a textfield.
+     * Use a relation to specify how to find
+     * the textfield in relation to a specific label.
+     *
+     * **Examples:**
+     * ```typescript
+     * // Finds the textfield nearest to the label 'Email'
+     * await aui.typeIntoTextfield({textToWrite: 'Hello World', relation: {label: 'Email'}});
+     *
+     * // Finds the textfield above/below a label 'Password'
+     * await aui.typeIntoTextfield(
+     *   {textToWrite: 'Hello World', relation: {type: 'above', label: 'Password'}}
+     * );
+     * await aui.typeIntoTextfield(
+     *   {textToWrite: 'Hello World', relation: {type: 'below', label: 'Password'}}
+     * );
+     *
+     * // If there is no label but a placeholder, the label is contained in the textfield
+     * await aui.typeIntoTextfield(
+     *   {textToWrite: 'Hello World', relation: {type: 'contains', label: 'Enter email'}}
+     * );
+     * ```
+     *
+     * @param {Object} params - Object containing required `textToWrite` property and
+     *                          optional `relation` property.
+     * @property {string} params.textToWrite - The text to be typed into the textfield.
+     * @property {Object} params.relation - Object describing the relationship between the
+     *                                      textfield being interacted with and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of
+     *                                                                   relation, optional.
+     * @property {string} params.relation.label - The label associated with the related
+     *                                            element, optional.
+     */
+    typeIntoTextfield(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let command = this.typeIn(params.textToWrite).textfield();
+            if (!params.relation.type) {
+                command = command.nearestTo().text(params.relation.label);
+            }
+            else {
+                command = this.evaluateRelation(command, params.relation.type, params.relation.label);
+            }
+            yield command.exec();
+        });
+    }
+    /**
+     * Click on a specific text.
+     * You can also use a RegEx or match the text exactly by specifyicing the specific flag.
+     * Use a relation to find the text in relation to a specific text.
+     *
+     * **Examples:**
+     * ```typescript
+     * // Click text that matches exactly
+     * await aui.clickText({text: 'askui', type: 'similar'})
+     *
+     * // Click text that contains 'pie' or 'cake' or 'Pie' or 'Cake'
+     * await aui.clickText({text: '.*([Pp]ie|[Cc]ake).*', type: 'regex'})
+     *
+     * // Click the text 'TERMINAL' that is left of the text 'Ports'
+     * await aui.clickText({
+     *     text: 'TERMINAL',
+     *     type: "exact",
+     *     relation: { type: 'leftOf', text: 'PORTS' }
+     *   })
+     * ```
+     * @param {Object} params - Object containing required `text` property and optional properties
+     *                          for regular expression matching and relation.
+     * @property {string} params.text - The text to be clicked.
+     * @property {string} params.type - Whether the text is matched using similarity,
+     *                                  exact match or a regular expression.
+     * @property {Object} params.relation - Object describing the relationship between the
+     *                                      clicked text and another element.
+     * @property {RelationsForConvenienceMethods} params.relation.type - The type of relation.
+     * @property {string} params.relation.text - The label or text associated with the
+     *                                           related element or state.
+     */
+    clickText(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let command = this.click().text();
+            switch (params.type) {
+                case 'similar':
+                    command = command.withText(params.text);
+                    break;
+                case 'exact':
+                    command = command.withExactText(params.text);
+                    break;
+                case 'regex':
+                    command = command.withTextRegex(params.text);
+                    break;
+                default:
+                    throw new ValidationError_1.default('"type" must be "similar", "exact" or "regex"');
+            }
+            if (params.relation) {
+                command = this.evaluateRelation(command, params.relation.type, params.relation.text);
+            }
+            yield command.exec();
+        });
+    }
 }
 exports.UiControlClient = UiControlClient;

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

@@ -2,27 +2,47 @@ import { CredentialArgs } from './credentials-args';
 import { ProxyAgentArgs } from '../shared/proxy-agent-args';
 import { ModelCompositionBranch } from './model-composition-branch';
 import { Reporter } from '../core/reporting';
+import { Context } from './context';
 /**
- * Configuration options for the askui UI Control Client
+ * Context object to provide additional information about the context of (test) automation.
  *
- * @param {string} uiControllerUrl - Default: http://127.0.0.1:6769
- * The adress of the askui UI Controller server.
- * @param {(number | undefined)} resize - Default: undefined
- * The resizing will be skipped if it's undefined.
- * The side length of the target image to resize to in px.
- * Your screenshot image will be resized with the original aspect ratio,
- *  and the lengths image side will be equal to this number.
- * This can be used to reduce the inference time by reducing
- *  the request size in case of a bad internet connection.
- * But it can cause a decrease in the prediction quality.
- * @param {string} inferenceServerUrl - Default: https://inference.askui.com`
- * Address of the askui Inference server.
- * @param {CredentialArgs} credentials - We need to provide credentials for
- * the authentication of the askui Inference Server.
- * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
- * @param {ProxyAgentArgs} proxyAgents - To configure the proxy agents for http(s) requests.
- * @param {Reporter | Reporter[]} reporter - To configure the reporter(s)
- *  to report on step runs/executions.
+ * @property {(boolean | undefined)} [isCi] - Default: Determined automatically by
+ *    https://github.com/watson/is-ci; see https://github.com/watson/ci-info#supported-ci-tools for
+ *    all supported CI tools. Can be used for overriding the automatic detection of CI tools, e.g.,
+ *    if not supported by `is-ci`, so that AskUI can be optimized for the corresponding
+ *    environment, e.g., adjusting caching behavior.
+ */
+export interface ContextArgs {
+    readonly isCi?: boolean | undefined;
+}
+/**
+ * Configuration options for AskUI's UiControlClient.
+ *
+ * @property {string} [uiControllerUrl] - Default: `'http://127.0.0.1:6769'`. The address of
+ *    AskUI's UiController that interacts with the operating system, e.g., simulating input
+ *    events and capturing screenshots.
+ * @property {string} [inferenceServerUrl] - Default: `'https://inference.askui.com'`.
+ *    Address of the AskUI's inference server which is responsible for understanding the
+ *    screenshots and extracting data from them and returning commands for the UiController.
+ * @property {(CredentialArgs | undefined)} [credentials] - Optional. Credentials for
+ *    the authenticating and authorizing with the inference server.
+ * @property {(ProxyAgentArgs | undefined)} [proxyAgents] - Optional. Proxy agents for http(s)
+ *    requests against the inference server if running behind a proxy.
+ * @property {number} [resize] - Optional. Length in px to resize the screenshot image to before
+ *    sending it to the inference server so that the screenshot image's longer side is equal to or
+ *    less than it. Aspect ratio (of width and height) is preserved. This can be used to reduce the
+ *    inference time by reducing the request size, e.g., if network bandwidth is limited. But it
+ *    can cause a decrease in the prediction quality. If undefined, the screenshot image is not
+ *    resized but sent as is.
+ * @property {(Reporter | Reporter[] | undefined)} [reporter] - Default: `[]`. To configure the
+ *    reporter(s) to report on steps (see
+ *    https://docs.askui.com/docs/next/general/Components/askui-ui-control-client#reporter).
+ * @property {ModelCompositionBranch[]} [modelComposition] - Default: `[]`. To configure the model
+ *    composition for the inference server, i.e., which models are used for the inference, e.g.,
+ *    test recognition or object detection.
+ * @property {(Context | undefined)} [context] - Optional. Context object to provide additional
+ *    information about the context of (test) automation, e.g., to allow for optimizations based on
+ *    the environment, e.g., CI/CD.
  */
 export interface ClientArgs {
     readonly uiControllerUrl?: string;
@@ -32,8 +52,10 @@ export interface ClientArgs {
     readonly resize?: number;
     readonly modelComposition?: ModelCompositionBranch[];
     readonly reporter?: Reporter | Reporter[] | undefined;
+    readonly context?: ContextArgs | undefined;
 }
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;
     readonly inferenceServerUrl: string;
+    readonly context: Context;
 }

package/dist/cjs/lib/interactive_cli/create-example-project.js

@@ -188,7 +188,7 @@ class CreateExampleProject {
         return __awaiter(this, void 0, void 0, function* () {
             const runCommand = (0, util_1.promisify)(child_process_1.exec);
             const frameworkDependencies = {
-                jest: 'npm i -D @askui/askui-reporters typescript ts-node @types/jest ts-jest jest @askui/jest-allure-circus eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-askui hpagent',
+                jest: 'npm i -D @askui/askui-reporters typescript ts-node @types/jest ts-jest jest @askui/jest-allure-circus eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import @askui/eslint-plugin-askui hpagent',
             };
             yield runCommand(frameworkDependencies.jest);
         });

package/dist/cjs/main.d.ts

@@ -1,5 +1,5 @@
 export { UiController } from './lib';
-export { UiControlClient } from './execution';
+export { UiControlClient, RelationsForConvenienceMethods } from './execution';
 export { Instruction, Reporter, ReporterConfig, Snapshot, SnapshotDetailLevel, Step, StepStatus, StepStatusEnd, } from './core/reporting';
 export { Annotation } from './core/annotation/annotation';
 export { DetectedElement } from './core/model/annotation-result/detected-element';

package/dist/cjs/utils/analytics/analytics-interface.d.ts

@@ -1,3 +1,4 @@
+import { Context } from '@/execution/context';
 export interface AnalyticsInterface {
-    getAnalyticsHeaders(): Promise<Record<string, string>>;
+    getAnalyticsHeaders(context: Context): Promise<Record<string, string>>;
 }

package/dist/cjs/utils/analytics/analytics.d.ts

@@ -1,6 +1,7 @@
 import { AnalyticsInterface } from './analytics-interface';
+import { Context } from '@/execution/context';
 export declare class Analytics implements AnalyticsInterface {
     private userIdentifier;
-    getAnalyticsHeaders(): Promise<Record<string, string>>;
+    getAnalyticsHeaders(context: Context): Promise<Record<string, string>>;
     getAnalyticsCookies(): Promise<Record<string, string>>;
 }

package/dist/cjs/utils/analytics/analytics.js

@@ -20,12 +20,13 @@ class Analytics {
     constructor() {
         this.userIdentifier = new user_identifier_1.UserIdentifier();
     }
-    getAnalyticsHeaders() {
+    getAnalyticsHeaders(context) {
         return __awaiter(this, void 0, void 0, function* () {
             const userID = yield this.userIdentifier.userId();
             const headers = {
-                'askui-user-id': userID,
+                'askui-is-ci': String(context.isCi),
                 'askui-user-agent': `os:${os_1.default.platform()};arch:${os_1.default.arch()}`,
+                'askui-user-id': userID,
             };
             const askuiInstalledAt = yield installation_timestamp_1.InstallationTimestamp.get();
             if (askuiInstalledAt) {

package/dist/esm/execution/context.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Context object to provide additional information about the context of (test) automation.
+ *
+ * @property {boolean} isCi - Default: Determined automatically by https://github.com/watson/is-ci;
+ *    see https://github.com/watson/ci-info#supported-ci-tools for all supported CI tools.
+ *    Can be used for overriding the automatic detection of CI tools, e.g., if not supported by
+ *    `is-ci`, so that AskUI can be optimized for the corresponding environment, e.g., adjusting
+ *    caching behavior.
+ */
+export interface Context {
+    readonly isCi: boolean;
+}