askui 0.27.0 → 0.28.1

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

@@ -602,4 +602,51 @@ export declare class UiControlClient extends ApiCommands {
      * @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>>;
 }

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

@@ -464,7 +464,7 @@ class UiControlClient extends dsl_1.ApiCommands {
                     throw error;
                 }
                 yield this.waitFor(waitTime).exec();
-                yield this.waitUntil(AskUICommand, maxTry - 1);
+                yield this.waitUntil(AskUICommand, maxTry - 1, waitTime);
             }
         });
     }
@@ -850,5 +850,56 @@ class UiControlClient extends dsl_1.ApiCommands {
             this.agent.addTool(askUIListAIElementTool);
         });
     }
+    /**
+     * 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() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.executionRuntime.getStartingArguments();
+        });
+    }
 }
 exports.UiControlClient = UiControlClient;

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

@@ -1,6 +1,6 @@
 import WebSocket from 'ws';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
-import { CaptureScreenshotResponse, ControlResponse, StartRecordingResponse, StopRecordingResponse, ReadRecordingPartResponse, InteractiveAnnotationResponse, GetProcessPidResponse } from '../core/runner-protocol';
+import { CaptureScreenshotResponse, ControlResponse, StartRecordingResponse, StopRecordingResponse, ReadRecordingPartResponse, InteractiveAnnotationResponse, GetProcessPidResponse, GetStartingArgumentsResponse } from '../core/runner-protocol';
 import { ControlCommand } from '../core/ui-control-commands';
 import { UiControllerClientConnectionState } from './ui-controller-client-connection-state';
 export declare class UiControllerClient {
@@ -22,6 +22,7 @@ export declare class UiControllerClient {
     private sendAndReceive;
     private send;
     requestScreenshot(): Promise<CaptureScreenshotResponse>;
+    getStartingArguments(): Promise<GetStartingArgumentsResponse>;
     getServerPid(): Promise<GetProcessPidResponse>;
     startVideoRecording(): Promise<StartRecordingResponse>;
     stopVideoRecording(): Promise<StopRecordingResponse>;

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

@@ -101,6 +101,9 @@ class UiControllerClient {
     requestScreenshot() {
         return this.sendAndReceive(new runner_protocol_1.CaptureScreenshotRequest());
     }
+    getStartingArguments() {
+        return this.sendAndReceive(new runner_protocol_1.GetStartingArgumentsRequest());
+    }
     getServerPid() {
         return this.sendAndReceive(new runner_protocol_1.GetProcessPidRequest());
     }

package/dist/esm/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/esm/core/runner-protocol/request/get-starting-arguments-request.js

@@ -0,0 +1,6 @@
+export class GetStartingArgumentsRequest {
+    constructor() {
+        this.msgName = GetStartingArgumentsRequest.msgName;
+    }
+}
+GetStartingArgumentsRequest.msgName = 'GET_STARTING_ARGUMENTS_REQUEST';

package/dist/esm/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/esm/core/runner-protocol/request/index.js

@@ -5,3 +5,4 @@ export { ReadRecordingRequest } from './read-recording-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/esm/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/esm/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/esm/execution/execution-runtime.js

@@ -180,6 +180,12 @@ export 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/esm/execution/ui-control-client.d.ts

@@ -602,4 +602,51 @@ export declare class UiControlClient extends ApiCommands {
      * @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>>;
 }

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

@@ -461,7 +461,7 @@ export class UiControlClient extends ApiCommands {
                     throw error;
                 }
                 yield this.waitFor(waitTime).exec();
-                yield this.waitUntil(AskUICommand, maxTry - 1);
+                yield this.waitUntil(AskUICommand, maxTry - 1, waitTime);
             }
         });
     }
@@ -847,4 +847,55 @@ export class UiControlClient extends ApiCommands {
             this.agent.addTool(askUIListAIElementTool);
         });
     }
+    /**
+     * 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() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.executionRuntime.getStartingArguments();
+        });
+    }
 }

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

@@ -1,6 +1,6 @@
 import WebSocket from 'ws';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
-import { CaptureScreenshotResponse, ControlResponse, StartRecordingResponse, StopRecordingResponse, ReadRecordingPartResponse, InteractiveAnnotationResponse, GetProcessPidResponse } from '../core/runner-protocol';
+import { CaptureScreenshotResponse, ControlResponse, StartRecordingResponse, StopRecordingResponse, ReadRecordingPartResponse, InteractiveAnnotationResponse, GetProcessPidResponse, GetStartingArgumentsResponse } from '../core/runner-protocol';
 import { ControlCommand } from '../core/ui-control-commands';
 import { UiControllerClientConnectionState } from './ui-controller-client-connection-state';
 export declare class UiControllerClient {
@@ -22,6 +22,7 @@ export declare class UiControllerClient {
     private sendAndReceive;
     private send;
     requestScreenshot(): Promise<CaptureScreenshotResponse>;
+    getStartingArguments(): Promise<GetStartingArgumentsResponse>;
     getServerPid(): Promise<GetProcessPidResponse>;
     startVideoRecording(): Promise<StartRecordingResponse>;
     stopVideoRecording(): Promise<StopRecordingResponse>;

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

@@ -1,5 +1,5 @@
 import WebSocket from 'ws';
-import { CaptureScreenshotRequest, ControlRequest, StartRecordingRequest, StopRecordingRequest, ReadRecordingRequest, InteractiveAnnotationRequest, GetProcessPidRequest, } from '../core/runner-protocol';
+import { CaptureScreenshotRequest, ControlRequest, StartRecordingRequest, StopRecordingRequest, ReadRecordingRequest, InteractiveAnnotationRequest, GetProcessPidRequest, GetStartingArgumentsRequest, } from '../core/runner-protocol';
 import { logger } from '../lib/logger';
 import { UiControllerClientConnectionState } from './ui-controller-client-connection-state';
 import { ReadRecordingResponseStreamHandler } from './read-recording-response-stream-handler';
@@ -95,6 +95,9 @@ export class UiControllerClient {
     requestScreenshot() {
         return this.sendAndReceive(new CaptureScreenshotRequest());
     }
+    getStartingArguments() {
+        return this.sendAndReceive(new GetStartingArgumentsRequest());
+    }
     getServerPid() {
         return this.sendAndReceive(new GetProcessPidRequest());
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.27.0",
+    "version": "0.28.1",
     "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",