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

Reliable, automated end-to-end-testing that depends on what is shown on your screen instead of the technology you are running on

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';
import { RetryStrategy } from './retry-strategies/retry-strategy';
import { AIElementArgs } from '../core/ai-element/ai-elements-args';
import { CacheConfig } from '../core/cache';
import { AndroidAdbClientArgs } from './android/android-adb-client';
import { LegacyAndroidClientArgs } from './legacy-controller/legacy-android-client';
/**
 * The runtime AskUI automates: the `desktop` via the AskUI AgentOS (gRPC), or an
 * `android` device (see {@link AndroidArgs} for the transport).
 */
export type Runtime = 'desktop' | 'android';
/**
 * How the Android runtime reaches the device.
 * - `legacy-controller` (default): connect to a running AskUI legacy UI Controller
 *   over WebSocket (`AskUI-StartController ... -r android`).
 * - `adb`: drive the device directly via `adb` (no controller process required).
 */
export type AndroidTransport = 'legacy-controller' | 'adb';
/**
 * Options for the Android runtime. `transport` selects how the device is reached;
 * the remaining options apply to the matching transport (`controllerUrl` for
 * `legacy-controller`; `id`/`adbPath`/`keyboard` for `adb`; `actionDelayInMs` for
 * both).
 */
export interface AndroidArgs extends AndroidAdbClientArgs, LegacyAndroidClientArgs {
    readonly transport?: AndroidTransport;
}
/**
 * Context object to provide additional information about the context of (test) automation.
 *
 * @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} [agentOsUrl] - Default: `'localhost:26000'`. The gRPC address of
 *    the AskUI AgentOS (AskUI Remote Device Controller) that interacts with the operating
 *    system, e.g., simulating input events and capturing screenshots. `localhost:26000` is
 *    the address of the AgentOS managed by the AskUI OS service (`AskuiCoreService`); set it
 *    to `localhost:23000` to connect to a standalone AgentOS instead.
 * @property {string} [uiControllerUrl] - **Deprecated.** Use {@link agentOsUrl} instead. Kept
 *    for backwards compatibility: used only when `agentOsUrl` is not set.
 * @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.
 * @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.
 * @property {Runtime} [runtime] - Default: `'desktop'`. The runtime to automate. `'desktop'`
 *   connects to the AskUI AgentOS via gRPC (see `agentOsUrl`); `'android'` automates an
 *   Android device (see `android`).
 * @property {AndroidArgs} [android] - Optional. Options for the Android runtime. `transport`
 *   selects how the device is reached (`'legacy-controller'` by default, or `'adb'`);
 *   `controllerUrl` configures the legacy controller address, `id`/`adbPath`/`keyboard` the
 *   adb transport. Only used when `runtime` is `'android'`.
 */
export interface ClientArgs {
    readonly agentOsUrl?: string;
    /**
     * @deprecated Use {@link agentOsUrl} instead. Used only when `agentOsUrl` is not set.
     */
    readonly uiControllerUrl?: string;
    readonly runtime?: Runtime;
    readonly android?: AndroidArgs;
    readonly inferenceServerUrl?: string;
    readonly credentials?: CredentialArgs | undefined;
    readonly proxyAgents?: ProxyAgentArgs | undefined;
    readonly resize?: number;
    readonly modelComposition?: ModelCompositionBranch[];
    readonly reporter?: Reporter | Reporter[] | undefined;
    readonly context?: ContextArgs | undefined;
    readonly inferenceServerApiVersion?: string;
    readonly retryStrategy?: RetryStrategy;
    readonly aiElementArgs?: AIElementArgs;
    readonly cacheConfig?: CacheConfig;
}
export interface ClientArgsWithDefaults extends ClientArgs {
    readonly agentOsUrl: string;
    readonly runtime: Runtime;
    readonly inferenceServerUrl: string;
    readonly context: Context;
    readonly inferenceServerApiVersion: string;
    readonly aiElementArgs: AIElementArgs;
    readonly retryStrategy?: RetryStrategy;
}