askui 0.26.0 → 0.28.0

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

@@ -8,5 +8,6 @@ export declare class AIElementCollection {
     static collectAIElements(workspaceId: string | undefined, aiElementArgs: AIElementArgs): Promise<AIElementCollection>;
     getByName(name: string): CustomElementJson[];
     getByNames(names: string[]): CustomElementJson[];
+    getNames(): string[];
     private static CollectAiElementsFromLocation;
 }

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

@@ -73,6 +73,9 @@ class AIElementCollection {
         }
         return names.flatMap((name) => this.getByName(name));
     }
+    getNames() {
+        return [...new Set(this.elements.map((element) => element.name))];
+    }
     static CollectAiElementsFromLocation(aiElementLocation) {
         const files = fs_extra_1.default.readdirSync(aiElementLocation);
         if (files.length === 0) {

package/dist/cjs/core/models/anthropic/askui-agent.d.ts

@@ -1,3 +1,4 @@
+import { OsAgentHandler } from './tools/os-agent-tools';
 import { ClaudeAgent } from './claude-agent';
 import { ExecutionRuntime } from '../../../execution/execution-runtime';
 export declare class AskUIAgent extends ClaudeAgent {
@@ -6,6 +7,7 @@ export declare class AskUIAgent extends ClaudeAgent {
     constructor(executionRuntime: ExecutionRuntime);
     isConnected(): boolean;
     initializeOsAgentHandler(): Promise<void>;
+    getOsAgentHandler(): OsAgentHandler;
     configureAsDesktopAgent(): Promise<void>;
     configureAsAndroidAgent(): Promise<void>;
     private static DesktopSystemPrompt;

package/dist/cjs/core/models/anthropic/askui-agent.js

@@ -26,6 +26,12 @@ class AskUIAgent extends claude_agent_1.ClaudeAgent {
             this.osAgentHandler = yield os_agent_tools_1.OsAgentHandler.createInstance(this.executionRuntime);
         });
     }
+    getOsAgentHandler() {
+        if (!this.osAgentHandler) {
+            throw new Error('Agent OS client is not connected');
+        }
+        return this.osAgentHandler;
+    }
     configureAsDesktopAgent() {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.osAgentHandler) {
@@ -33,6 +39,7 @@ class AskUIAgent extends claude_agent_1.ClaudeAgent {
             }
             const tools = [
                 new os_agent_tools_1.AgentErrorTool(),
+                new os_agent_tools_1.PrintTool(),
                 new os_agent_tools_1.ScreenShotTool(this.osAgentHandler),
                 new os_agent_tools_1.MouseMoveTool(this.osAgentHandler),
                 new os_agent_tools_1.MouseClickTool(this.osAgentHandler),

package/dist/cjs/core/models/anthropic/claude-agent.js

@@ -26,7 +26,7 @@ class ClaudeAgent {
         this.tools = [];
         this.history = {};
         this.toolChoice = {
-            type: 'any',
+            type: 'auto',
         };
     }
     setToolChoice(toolChoice) {

package/dist/cjs/core/models/anthropic/index.d.ts

@@ -1,3 +1,3 @@
 export { AskUIAgent } from './askui-agent';
-export { ToolFailure, ToolError, BaseAgentTool } from './tools/base';
+export { ToolFailure, ToolError, BaseAgentTool, BetaTool, ToolResult, } from './tools/base';
 export { AgentHistory, ActOptions } from './claude-agent';

package/dist/cjs/core/models/anthropic/tools/askui-api-tools.d.ts

@@ -0,0 +1,19 @@
+import { DetectedElement } from '../../../model/annotation-result/detected-element';
+import { BaseAgentTool, ToolResult, BetaTool } from './base';
+import { OsAgentHandler } from './os-agent-tools';
+export declare class AskUIGetAskUIElementTool extends BaseAgentTool {
+    private osAgentHandler;
+    private locatorFunction;
+    private elementType;
+    constructor(osAgentHandler: OsAgentHandler, locatorFunction: (aiElementName: string) => Promise<DetectedElement[]>, elementType: string);
+    execute(params: {
+        elementName: string;
+    }): Promise<ToolResult>;
+    toParams(): BetaTool;
+}
+export declare class AskUIListAIElementTool extends BaseAgentTool {
+    private listFunction;
+    constructor(listFunction: () => Promise<string[]>);
+    execute(): Promise<ToolResult>;
+    toParams(): BetaTool;
+}

package/dist/cjs/core/models/anthropic/tools/askui-api-tools.js

@@ -0,0 +1,81 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AskUIListAIElementTool = exports.AskUIGetAskUIElementTool = void 0;
+const base_1 = require("./base");
+class AskUIGetAskUIElementTool extends base_1.BaseAgentTool {
+    constructor(osAgentHandler, locatorFunction, elementType) {
+        super();
+        this.osAgentHandler = osAgentHandler;
+        this.locatorFunction = locatorFunction;
+        this.elementType = elementType;
+    }
+    execute(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { elementName } = params;
+            const detectedElements = yield this.locatorFunction(elementName);
+            const scaledElementsBoundingBoxes = detectedElements.map((element) => {
+                const xMid = (element.bndbox.xmin + element.bndbox.xmax) / 2;
+                const yMid = (element.bndbox.ymin + element.bndbox.ymax) / 2;
+                const [x, y] = this.osAgentHandler.scaleCoordinates('computer', xMid, yMid);
+                return {
+                    x, y,
+                };
+            });
+            return {
+                output: `Found ${scaledElementsBoundingBoxes.length} elements of type ${this.elementType}. center coordinates: ${JSON.stringify(scaledElementsBoundingBoxes)}`,
+            };
+        });
+    }
+    toParams() {
+        return {
+            description: `Locates and retrieves the bounding box coordinates of AskUI ${this.elementType} elements on the screen. ` +
+                `This tool is essential for UI automation as it provides the exact pixel coordinates needed to interact with UI elements. ` +
+                `The coordinates returned  can be used for clicking, hovering, or other mouse interactions. ` +
+                `Use this tool when you need to find and interact with specific ${this.elementType} UI elements by their semantic names.`,
+            input_schema: {
+                properties: {
+                    elementName: {
+                        type: 'string',
+                        description: `The semantic name or identifier of the ${this.elementType} element to locate on the screen. `
+                    },
+                },
+                required: ['elementName'],
+                type: 'object',
+            },
+            name: `get_askui_${this.elementType}_element_tool`,
+        };
+    }
+}
+exports.AskUIGetAskUIElementTool = AskUIGetAskUIElementTool;
+class AskUIListAIElementTool extends base_1.BaseAgentTool {
+    constructor(listFunction) {
+        super();
+        this.listFunction = listFunction;
+    }
+    execute() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const elementNames = yield this.listFunction();
+            return {
+                output: `Found ${elementNames.length} element names that can be used to retrieve bounding boxes. Names: ${JSON.stringify(elementNames)}`,
+            };
+        });
+    }
+    toParams() {
+        return {
+            description: 'Retrieves a comprehensive list of all valid AskUI AI element names that can be used for element location and interaction. ' +
+                'The returned names can be used as input for the get_askui_aiElement_element_tool to locate specific ai elements. ',
+            input_schema: { type: 'object', properties: {}, required: [] },
+            name: 'list_ai_element_names_tool',
+        };
+    }
+}
+exports.AskUIListAIElementTool = AskUIListAIElementTool;

package/dist/cjs/core/models/anthropic/tools/base.d.ts

@@ -1,3 +1,5 @@
+import { BetaTool as AnthropicBetaTool } from '@anthropic-ai/sdk/resources/beta/messages/messages';
+export type BetaTool = AnthropicBetaTool;
 export interface ToolResult {
     output?: string;
     error?: string;

package/dist/cjs/core/models/anthropic/tools/os-agent-tools.d.ts

@@ -24,7 +24,7 @@ export declare class OsAgentHandler {
     };
     setTargetResolution(width: number, height: number): void;
     takeScreenshot(): Promise<string>;
-    private scaleCoordinates;
+    scaleCoordinates(source: 'api' | 'computer', x: number, y: number): [number, number];
     requestControl(controlCommand: ControlCommand): Promise<void>;
     mouseMove(x: number, y: number): Promise<void>;
     mouseClick(button: "left" | "right" | "middle", doubleClick: boolean): Promise<void>;
@@ -35,6 +35,9 @@ export declare class OsAgentHandler {
     desktopKeyHoldDown(key: PC_AND_MODIFIER_KEY, modifiers?: MODIFIER_KEY[]): Promise<void>;
     desktopKeyRelease(key: PC_AND_MODIFIER_KEY, modifiers?: MODIFIER_KEY[]): Promise<void>;
     typeText(text: string): Promise<void>;
+    androidKeyPress(key: ANDROID_KEY): Promise<void>;
+    androidKeySequencePress(keys: ANDROID_KEY[]): Promise<void>;
+    executeShellCommand(command: string): Promise<void>;
 }
 export declare class ScreenShotTool extends BaseAgentTool {
     private osAgentHandler;
@@ -165,3 +168,10 @@ export declare class WaitTool extends BaseAgentTool {
     }): Promise<ToolResult>;
     toParams(): BetaTool;
 }
+export declare class PrintTool extends BaseAgentTool {
+    constructor();
+    execute(command: {
+        text: string;
+    }): Promise<ToolResult>;
+    toParams(): BetaTool;
+}

package/dist/cjs/core/models/anthropic/tools/os-agent-tools.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WaitTool = exports.ExecuteShellCommandTool = exports.AgentErrorTool = exports.AndroidSequenceKeyPressTool = exports.AndroidSingleKeyPressTool = exports.TypeTool = exports.DesktopKeyReleaseTool = exports.DesktopKeyHoldDownTool = exports.DesktopPressAndReleaseKeysTool = exports.MouseReleaseLeftButtonTool = exports.MouseHoldLeftButtonDownTool = exports.MouseDragAndDropTool = exports.MouseScrollTool = exports.MouseClickTool = exports.MouseMoveTool = exports.ScreenShotTool = exports.OsAgentHandler = void 0;
+exports.PrintTool = exports.WaitTool = exports.ExecuteShellCommandTool = exports.AgentErrorTool = exports.AndroidSequenceKeyPressTool = exports.AndroidSingleKeyPressTool = exports.TypeTool = exports.DesktopKeyReleaseTool = exports.DesktopKeyHoldDownTool = exports.DesktopPressAndReleaseKeysTool = exports.MouseReleaseLeftButtonTool = exports.MouseHoldLeftButtonDownTool = exports.MouseDragAndDropTool = exports.MouseScrollTool = exports.MouseClickTool = exports.MouseMoveTool = exports.ScreenShotTool = exports.OsAgentHandler = void 0;
 const dsl_1 = require("../../../../execution/dsl");
 const base_1 = require("./base");
 const ui_control_commands_1 = require("../../../ui-control-commands");
@@ -205,6 +205,24 @@ class OsAgentHandler {
             yield this.requestControl(controlCommand);
         });
     }
+    androidKeyPress(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const controlCommand = new ui_control_commands_1.ControlCommand(ui_control_commands_1.ControlCommandCode.OK, [new ui_control_commands_1.Action(ui_control_commands_1.InputEvent.PRESS_ANDROID_SINGLE_KEY, { x: 0, y: 0 }, key, {})]);
+            yield this.requestControl(controlCommand);
+        });
+    }
+    androidKeySequencePress(keys) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const controlCommand = new ui_control_commands_1.ControlCommand(ui_control_commands_1.ControlCommandCode.OK, [new ui_control_commands_1.Action(ui_control_commands_1.InputEvent.PRESS_ANDROID_KEY_SEQUENCE, { x: 0, y: 0 }, keys.join(' '), {})]);
+            yield this.requestControl(controlCommand);
+        });
+    }
+    executeShellCommand(command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const controlCommand = new ui_control_commands_1.ControlCommand(ui_control_commands_1.ControlCommandCode.OK, [new ui_control_commands_1.Action(ui_control_commands_1.InputEvent.EXECUTE_COMMAND, { x: 0, y: 0 }, command, {})]);
+            yield this.requestControl(controlCommand);
+        });
+    }
 }
 exports.OsAgentHandler = OsAgentHandler;
 class ScreenShotTool extends base_1.BaseAgentTool {
@@ -556,8 +574,7 @@ class TypeTool extends base_1.BaseAgentTool {
     }
     execute(command) {
         return __awaiter(this, void 0, void 0, function* () {
-            const controlCommand = new ui_control_commands_1.ControlCommand(ui_control_commands_1.ControlCommandCode.OK, [new ui_control_commands_1.Action(ui_control_commands_1.InputEvent.TYPE, { x: 0, y: 0 }, command.text, {})]);
-            yield this.osAgentHandler.requestControl(controlCommand);
+            yield this.osAgentHandler.typeText(command.text);
             return {
                 output: `Typed text: ${command.text}`,
             };
@@ -588,8 +605,7 @@ class AndroidSingleKeyPressTool extends base_1.BaseAgentTool {
     }
     execute(command) {
         return __awaiter(this, void 0, void 0, function* () {
-            const controlCommand = new ui_control_commands_1.ControlCommand(ui_control_commands_1.ControlCommandCode.OK, [new ui_control_commands_1.Action(ui_control_commands_1.InputEvent.PRESS_KEY_SEQUENCE, { x: 0, y: 0 }, command.key, {})]);
-            yield this.osAgentHandler.requestControl(controlCommand);
+            yield this.osAgentHandler.androidKeyPress(command.key);
             return {
                 output: `Pressed Android key ${command.key}`,
             };
@@ -621,8 +637,7 @@ class AndroidSequenceKeyPressTool extends base_1.BaseAgentTool {
     }
     execute(command) {
         return __awaiter(this, void 0, void 0, function* () {
-            const controlCommand = new ui_control_commands_1.ControlCommand(ui_control_commands_1.ControlCommandCode.OK, [new ui_control_commands_1.Action(ui_control_commands_1.InputEvent.PRESS_KEY_SEQUENCE, { x: 0, y: 0 }, command.keys.join(' '), {})]);
-            yield this.osAgentHandler.requestControl(controlCommand);
+            yield this.osAgentHandler.androidKeySequencePress(command.keys);
             return {
                 output: `Pressed Android keys: ${command.keys.join(', ')}`,
             };
@@ -662,7 +677,7 @@ class AgentErrorTool extends base_1.BaseAgentTool {
     toParams() {
         return {
             name: 'agent_error_tool',
-            description: 'Raises an error in the agent',
+            description: 'Intentionally raises an error to signal that the agent cannot proceed with the current task. Use this when the agent encounters an unsolvable problem, gets stuck in a loop, or needs to communicate a critical failure that prevents further automation.',
             input_schema: {
                 type: 'object',
                 properties: {
@@ -684,8 +699,7 @@ class ExecuteShellCommandTool extends base_1.BaseAgentTool {
     }
     execute(command) {
         return __awaiter(this, void 0, void 0, function* () {
-            const controlCommand = new ui_control_commands_1.ControlCommand(ui_control_commands_1.ControlCommandCode.OK, [new ui_control_commands_1.Action(ui_control_commands_1.InputEvent.EXECUTE_COMMAND, { x: 0, y: 0 }, command.command, {})]);
-            yield this.osAgentHandler.requestControl(controlCommand);
+            yield this.osAgentHandler.executeShellCommand(command.command);
             return {
                 output: `Executed shell command: ${command.command}`,
             };
@@ -739,3 +753,33 @@ class WaitTool extends base_1.BaseAgentTool {
     }
 }
 exports.WaitTool = WaitTool;
+class PrintTool extends base_1.BaseAgentTool {
+    constructor() {
+        super();
+    }
+    execute(command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(command.text);
+            return {
+                output: `Printed text: ${command.text}`,
+            };
+        });
+    }
+    toParams() {
+        return {
+            name: 'print_tool',
+            description: 'Outputs text to the console for debugging, status updates, or user communication. Useful for providing feedback about automation progress, errors, or important information during test execution.',
+            input_schema: {
+                type: 'object',
+                properties: {
+                    text: {
+                        type: 'string',
+                        description: 'The text to output to the console.',
+                    },
+                },
+                required: ['text'],
+            },
+        };
+    }
+}
+exports.PrintTool = PrintTool;

package/dist/cjs/core/runner-protocol/request/get-starting-arguments-request.d.ts

@@ -0,0 +1,5 @@
+import { RunnerProtocolRequest } from './runner-protocol-request';
+export declare class GetStartingArgumentsRequest implements RunnerProtocolRequest {
+    static msgName: string;
+    msgName: string;
+}

package/dist/cjs/core/runner-protocol/request/get-starting-arguments-request.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetStartingArgumentsRequest = void 0;
+class GetStartingArgumentsRequest {
+    constructor() {
+        this.msgName = GetStartingArgumentsRequest.msgName;
+    }
+}
+exports.GetStartingArgumentsRequest = GetStartingArgumentsRequest;
+GetStartingArgumentsRequest.msgName = 'GET_STARTING_ARGUMENTS_REQUEST';

package/dist/cjs/core/runner-protocol/request/index.d.ts

@@ -6,3 +6,4 @@ export { RunnerProtocolRequest } from './runner-protocol-request';
 export { StartRecordingRequest } from './start-recording-request';
 export { StopRecordingRequest } from './stop-recording-request';
 export { GetProcessPidRequest } from './get-server-process-pid';
+export { GetStartingArgumentsRequest } from './get-starting-arguments-request';

package/dist/cjs/core/runner-protocol/request/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetProcessPidRequest = exports.StopRecordingRequest = exports.StartRecordingRequest = exports.ReadRecordingRequest = exports.InteractiveAnnotationRequest = exports.ControlRequest = exports.CaptureScreenshotRequest = void 0;
+exports.GetStartingArgumentsRequest = exports.GetProcessPidRequest = exports.StopRecordingRequest = exports.StartRecordingRequest = exports.ReadRecordingRequest = exports.InteractiveAnnotationRequest = exports.ControlRequest = exports.CaptureScreenshotRequest = void 0;
 var capture_screenshot_request_1 = require("./capture-screenshot-request");
 Object.defineProperty(exports, "CaptureScreenshotRequest", { enumerable: true, get: function () { return capture_screenshot_request_1.CaptureScreenshotRequest; } });
 var control_request_1 = require("./control-request");
@@ -15,3 +15,5 @@ var stop_recording_request_1 = require("./stop-recording-request");
 Object.defineProperty(exports, "StopRecordingRequest", { enumerable: true, get: function () { return stop_recording_request_1.StopRecordingRequest; } });
 var get_server_process_pid_1 = require("./get-server-process-pid");
 Object.defineProperty(exports, "GetProcessPidRequest", { enumerable: true, get: function () { return get_server_process_pid_1.GetProcessPidRequest; } });
+var get_starting_arguments_request_1 = require("./get-starting-arguments-request");
+Object.defineProperty(exports, "GetStartingArgumentsRequest", { enumerable: true, get: function () { return get_starting_arguments_request_1.GetStartingArgumentsRequest; } });

package/dist/cjs/core/runner-protocol/response/index.d.ts

@@ -100,3 +100,10 @@ export interface GetProcessPidResponse {
     };
     msgName: 'GET_PROCESS_PID_RESPONSE';
 }
+export interface GetStartingArgumentsResponse {
+    data: {
+        error?: string;
+        arguments: Record<string, string>;
+    };
+    msgName: 'GET_STARTING_ARGUMENTS_RESPONSE';
+}

package/dist/cjs/execution/execution-runtime.d.ts

@@ -37,6 +37,7 @@ export declare class ExecutionRuntime {
     private predictCommand;
     annotateInteractively(): Promise<void>;
     takeScreenshotIfImageisNotProvided(imagePath?: string): Promise<string>;
+    getStartingArguments(): Promise<Record<string, string | number | boolean>>;
     getDetectedElements(instruction: string, customElementJson?: CustomElementJson[]): Promise<DetectedElement[]>;
     annotateImage(imagePath?: string, customElementJson?: CustomElementJson[], elements?: DetectedElement[]): Promise<Annotation>;
     predictVQA(prompt: string, config?: object): Promise<any>;

package/dist/cjs/execution/execution-runtime.js

@@ -183,6 +183,12 @@ class ExecutionRuntime {
             return base64Image;
         });
     }
+    getStartingArguments() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const startingArgumentsResponse = yield this.uiControllerClient.getStartingArguments();
+            return startingArgumentsResponse.data.arguments;
+        });
+    }
     getDetectedElements(instruction, customElementJson) {
         return __awaiter(this, void 0, void 0, function* () {
             let customElements = [];

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

@@ -55,6 +55,7 @@ export declare class UiControlClient extends ApiCommands {
     stopVideoRecording(): Promise<void>;
     readVideoRecording(): Promise<string>;
     private shouldAnnotateAfterCommandExecution;
+    private beforeNoneInferenceCallCommandExecution;
     private afterCommandExecution;
     annotate(annotationRequest?: AnnotationRequest): Promise<Annotation>;
     annotateInteractively(): Promise<void>;
@@ -475,6 +476,28 @@ export declare class UiControlClient extends ApiCommands {
      * @returns {ExpectAllExistResult.elements} - ExpectExistenceElement[].
      */
     expectAllExist(query: ElementExistsQuery[]): Promise<ExpectAllExistResult>;
+    /**
+     * Holds down a key on the keyboard.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.keyDown('a').exec();
+     * ```
+     *
+     * @param {PC_AND_MODIFIER_KEY} key - The key to hold down.
+     */
+    keyDown(key: PC_AND_MODIFIER_KEY): Executable;
+    /**
+     * Releases a key up that was previously held down.
+     *
+     * **Examples:**
+     * ```typescript
+     * await aui.keyUp('a').exec();
+     * ```
+     *
+     * @param {PC_AND_MODIFIER_KEY} key - The key to release up.
+     */
+    keyUp(key: PC_AND_MODIFIER_KEY): Executable;
     /**
      * Instructs the agent to autonomously achieve a specified goal through UI interactions.
      *
@@ -573,4 +596,57 @@ export declare class UiControlClient extends ApiCommands {
      */
     act(goal: string, options?: ActOptions): Promise<AgentHistory>;
     act(goal: string, imagePathOrBase64String: string, options?: ActOptions): Promise<AgentHistory>;
+    /**
+     * Adds tools to the agent that allow it to interact with AI elements.
+     *
+     * @returns {Promise<void>} - A promise that resolves when the tools are added to the agent.
+     */
+    addAIElementsToolsToAgent(): Promise<void>;
+    /**
+     * Retrieves the starting arguments used when the controller server was initialized.
+     *
+     * Useful for debugging, logging, or verifying the current server configuration.
+     *
+     * @property {string} displayNum - Display number controlled by the controller
+     * @property {boolean} minimize - Whether controller starts minimized
+     * @property {string} runtime - Runtime type ("desktop" or "android")
+     * @property {number} port - Communication port
+     * @property {number} actionWaitTime - Action wait time
+     * @property {string} host - Host address
+     * @property {string} logFile - Log file path
+     * @property {boolean} hideOverlay - Whether overlay is hidden
+     * @property {boolean} debugDraw - Whether debug drawing is enabled
+     * @property {string} deviceId - Android device ID
+     * @property {string} configFile - Configuration file path
+     * @property {string} logLevel - Logging level
+     *
+     * @example
+     * ```typescript
+     * const startingArguments = await aui.getControllerStartingArguments();
+     * console.log(startingArguments);
+     * // Output example:
+     * // {
+     * //   displayNum: 0,
+     * //   minimize: true,
+     * //   runtime: 'desktop',
+     * //   port: 5000,
+     * //   actionWaitTime: 1000,
+     * //   host: '127.0.0.1',
+     * //   logFile: '/tmp/askui/askui-server.log',
+     * //   hideOverlay: false,
+     * //   debugDraw: false,
+     * //   deviceId: 'emulator-5554',
+     * //   configFile: '/tmp/askui/askui-config.json',
+     * //   logLevel: 'info',
+     * // }
+    * ```
+    *
+    * @example Retrieving Android device ID:
+    * ```typescript
+    * const startingArguments = await aui.getControllerStartingArguments();
+    * console.log(startingArguments.deviceId);
+    * // Output example: "emulator-5554"
+    * ```
+    */
+    getControllerStartingArguments(): Promise<Record<'displayNum' | 'minimize' | 'runtime' | 'port' | 'actionWaitTime' | 'host' | 'logFile' | 'hideOverlay' | 'debugDraw' | 'deviceId' | 'configFile' | 'logLevel', string | number | boolean>>;
 }