airbrowser-client 1.13.1 → 1.14.0

package/dist/api.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProfilesApi = exports.ProfilesApiFactory = exports.ProfilesApiFp = exports.ProfilesApiAxiosParamCreator = exports.PoolApi = exports.PoolApiFactory = exports.PoolApiFp = exports.PoolApiAxiosParamCreator = exports.HealthApi = exports.HealthApiFactory = exports.HealthApiFp = exports.HealthApiAxiosParamCreator = exports.BrowserApi = exports.BrowserApiFactory = exports.BrowserApiFp = exports.BrowserApiAxiosParamCreator = exports.WaitElementRequestUntilEnum = exports.TabsRequestActionEnum = exports.SelectRequestActionEnum = exports.PerformanceRequestActionEnum = exports.NetworkLogsRequestActionEnum = exports.MouseRequestActionEnum = exports.HistoryRequestActionEnum = exports.EmulateRequestActionEnum = exports.DialogRequestActionEnum = exports.CookiesRequestActionEnum = exports.ConsoleLogsRequestActionEnum = exports.BrowsersRequestActionEnum = void 0;
+exports.ProfilesApi = exports.ProfilesApiFactory = exports.ProfilesApiFp = exports.ProfilesApiAxiosParamCreator = exports.PoolApi = exports.PoolApiFactory = exports.PoolApiFp = exports.PoolApiAxiosParamCreator = exports.HealthApi = exports.HealthApiFactory = exports.HealthApiFp = exports.HealthApiAxiosParamCreator = exports.BrowserApi = exports.BrowserApiFactory = exports.BrowserApiFp = exports.BrowserApiAxiosParamCreator = exports.WaitElementRequestUntilEnum = exports.TabsRequestActionEnum = exports.SelectRequestActionEnum = exports.PerformanceRequestActionEnum = exports.NetworkLogsRequestActionEnum = exports.MouseRequestActionEnum = exports.HistoryRequestActionEnum = exports.GuiClickXYRequestPostClickFeedbackEnum = exports.GuiClickXYRequestAutoSnapEnum = exports.GuiClickXYRequestPreClickValidateEnum = exports.GuiClickRequestPostClickFeedbackEnum = exports.GuiClickRequestAutoSnapEnum = exports.GuiClickRequestPreClickValidateEnum = exports.EmulateRequestActionEnum = exports.DialogRequestActionEnum = exports.DetectCoordinatesRequestAutoSnapEnum = exports.DetectCoordinatesRequestHitTestEnum = exports.CookiesRequestActionEnum = exports.ConsoleLogsRequestActionEnum = exports.BrowsersRequestActionEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -49,6 +49,16 @@ exports.CookiesRequestActionEnum = {
     Delete: 'delete',
     Clear: 'clear',
 };
+exports.DetectCoordinatesRequestHitTestEnum = {
+    Off: 'off',
+    Warn: 'warn',
+    Strict: 'strict',
+};
+exports.DetectCoordinatesRequestAutoSnapEnum = {
+    Off: 'off',
+    NearestClickable: 'nearest_clickable',
+    NearestInteractive: 'nearest_interactive',
+};
 exports.DialogRequestActionEnum = {
     Get: 'get',
     Accept: 'accept',
@@ -59,6 +69,40 @@ exports.EmulateRequestActionEnum = {
     Clear: 'clear',
     ListDevices: 'list_devices',
 };
+exports.GuiClickRequestPreClickValidateEnum = {
+    Off: 'off',
+    Warn: 'warn',
+    Strict: 'strict',
+};
+exports.GuiClickRequestAutoSnapEnum = {
+    Off: 'off',
+    NearestClickable: 'nearest_clickable',
+    NearestInteractive: 'nearest_interactive',
+};
+exports.GuiClickRequestPostClickFeedbackEnum = {
+    None: 'none',
+    Url: 'url',
+    Content: 'content',
+    Visible: 'visible',
+    Auto: 'auto',
+};
+exports.GuiClickXYRequestPreClickValidateEnum = {
+    Off: 'off',
+    Warn: 'warn',
+    Strict: 'strict',
+};
+exports.GuiClickXYRequestAutoSnapEnum = {
+    Off: 'off',
+    NearestClickable: 'nearest_clickable',
+    NearestInteractive: 'nearest_interactive',
+};
+exports.GuiClickXYRequestPostClickFeedbackEnum = {
+    None: 'none',
+    Url: 'url',
+    Content: 'content',
+    Visible: 'visible',
+    Auto: 'auto',
+};
 exports.HistoryRequestActionEnum = {
     Back: 'back',
     Forward: 'forward',
@@ -344,8 +388,8 @@ const BrowserApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Args:     browser_id: Browser instance identifier     prompt: Natural language description of element to find     fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right).         If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10).     fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
-         * @summary Detect element coordinates using vision
+         * Args:     browser_id: Browser instance identifier     prompt: Natural language description of element to find     fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right).         If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10).     fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).     model: Optional vision model override for this request.     stream: Optional vision streaming override for this request.     hit_test: Detect-time validation mode: off, warn, or strict.         Recommended for agents: `strict`.     auto_snap: Auto-snap mode: off, nearest_clickable, or nearest_interactive.         Recommended for agents: `nearest_clickable`.     snap_radius: Maximum snap radius in CSS pixels.     include_debug: Include detect debug diagnostics when available.
+         * @summary Detect element coordinates using vision with optional smart targeting
          * @param {string} browserId
          * @param {DetectCoordinatesRequest} payload
          * @param {*} [options] Override http request option.
@@ -694,8 +738,8 @@ const BrowserApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary GUI click by selector or coordinates
+         * Selector mode uses `selector` with optional `fx` / `fy` offsets. Coordinate mode uses `x` / `y` and supports smart targeting knobs such as `pre_click_validate`, `auto_snap`, and `post_click_feedback`.  Recommended agent mode: - `pre_click_validate=\"strict\"` - `auto_snap=\"nearest_clickable\"` - `post_click_feedback=\"auto\"`  MCP keeps `gui_click_xy` as a compatibility alias for coordinate-mode `gui_click`.
+         * @summary GUI click by selector or coordinates with smart validation
          * @param {string} browserId
          * @param {GuiClickRequest} payload
          * @param {*} [options] Override http request option.
@@ -728,6 +772,41 @@ const BrowserApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * This mirrors coordinate-mode `gui_click`, accepts the same smart-click options, and returns the same response contract.
+         * @summary MCP compatibility alias for coordinate-mode `gui_click`
+         * @param {string} browserId
+         * @param {GuiClickXYRequest} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        guiClickXy: (browserId_1, payload_1, ...args_1) => __awaiter(this, [browserId_1, payload_1, ...args_1], void 0, function* (browserId, payload, options = {}) {
+            // verify required parameter 'browserId' is not null or undefined
+            (0, common_1.assertParamExists)('guiClickXy', 'browserId', browserId);
+            // verify required parameter 'payload' is not null or undefined
+            (0, common_1.assertParamExists)('guiClickXy', 'payload', payload);
+            const localVarPath = `/browser/{browser_id}/gui_click_xy`
+                .replace(`{${"browser_id"}}`, encodeURIComponent(String(browserId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(payload, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          *
          * @summary GUI hover at coordinates
@@ -1362,12 +1441,15 @@ const BrowserApiAxiosParamCreator = function (configuration) {
          *
          * @summary AI page analysis - what\'s visible
          * @param {string} browserId
+         * @param {WhatIsVisibleRequest} payload
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        whatIsVisible: (browserId_1, ...args_1) => __awaiter(this, [browserId_1, ...args_1], void 0, function* (browserId, options = {}) {
+        whatIsVisible: (browserId_1, payload_1, ...args_1) => __awaiter(this, [browserId_1, payload_1, ...args_1], void 0, function* (browserId, payload, options = {}) {
             // verify required parameter 'browserId' is not null or undefined
             (0, common_1.assertParamExists)('whatIsVisible', 'browserId', browserId);
+            // verify required parameter 'payload' is not null or undefined
+            (0, common_1.assertParamExists)('whatIsVisible', 'payload', payload);
             const localVarPath = `/browser/{browser_id}/what_is_visible`
                 .replace(`{${"browser_id"}}`, encodeURIComponent(String(browserId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -1379,10 +1461,12 @@ const BrowserApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
+            localVarHeaderParameter['Content-Type'] = 'application/json';
             localVarHeaderParameter['Accept'] = 'application/json';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(payload, localVarRequestOptions, configuration);
             return {
                 url: (0, common_1.toPathString)(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -1516,8 +1600,8 @@ const BrowserApiFp = function (configuration) {
             });
         },
         /**
-         * Args:     browser_id: Browser instance identifier     prompt: Natural language description of element to find     fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right).         If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10).     fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
-         * @summary Detect element coordinates using vision
+         * Args:     browser_id: Browser instance identifier     prompt: Natural language description of element to find     fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right).         If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10).     fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).     model: Optional vision model override for this request.     stream: Optional vision streaming override for this request.     hit_test: Detect-time validation mode: off, warn, or strict.         Recommended for agents: `strict`.     auto_snap: Auto-snap mode: off, nearest_clickable, or nearest_interactive.         Recommended for agents: `nearest_clickable`.     snap_radius: Maximum snap radius in CSS pixels.     include_debug: Include detect debug diagnostics when available.
+         * @summary Detect element coordinates using vision with optional smart targeting
          * @param {string} browserId
          * @param {DetectCoordinatesRequest} payload
          * @param {*} [options] Override http request option.
@@ -1686,8 +1770,8 @@ const BrowserApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary GUI click by selector or coordinates
+         * Selector mode uses `selector` with optional `fx` / `fy` offsets. Coordinate mode uses `x` / `y` and supports smart targeting knobs such as `pre_click_validate`, `auto_snap`, and `post_click_feedback`.  Recommended agent mode: - `pre_click_validate=\"strict\"` - `auto_snap=\"nearest_clickable\"` - `post_click_feedback=\"auto\"`  MCP keeps `gui_click_xy` as a compatibility alias for coordinate-mode `gui_click`.
+         * @summary GUI click by selector or coordinates with smart validation
          * @param {string} browserId
          * @param {GuiClickRequest} payload
          * @param {*} [options] Override http request option.
@@ -1702,6 +1786,23 @@ const BrowserApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * This mirrors coordinate-mode `gui_click`, accepts the same smart-click options, and returns the same response contract.
+         * @summary MCP compatibility alias for coordinate-mode `gui_click`
+         * @param {string} browserId
+         * @param {GuiClickXYRequest} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        guiClickXy(browserId, payload, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.guiClickXy(browserId, payload, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['BrowserApi.guiClickXy']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          *
          * @summary GUI hover at coordinates
@@ -2012,13 +2113,14 @@ const BrowserApiFp = function (configuration) {
          *
          * @summary AI page analysis - what\'s visible
          * @param {string} browserId
+         * @param {WhatIsVisibleRequest} payload
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        whatIsVisible(browserId, options) {
+        whatIsVisible(browserId, payload, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.whatIsVisible(browserId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.whatIsVisible(browserId, payload, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['BrowserApi.whatIsVisible']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2110,8 +2212,8 @@ const BrowserApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createBrowser(payload, options).then((request) => request(axios, basePath));
         },
         /**
-         * Args:     browser_id: Browser instance identifier     prompt: Natural language description of element to find     fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right).         If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10).     fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
-         * @summary Detect element coordinates using vision
+         * Args:     browser_id: Browser instance identifier     prompt: Natural language description of element to find     fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right).         If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10).     fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).     model: Optional vision model override for this request.     stream: Optional vision streaming override for this request.     hit_test: Detect-time validation mode: off, warn, or strict.         Recommended for agents: `strict`.     auto_snap: Auto-snap mode: off, nearest_clickable, or nearest_interactive.         Recommended for agents: `nearest_clickable`.     snap_radius: Maximum snap radius in CSS pixels.     include_debug: Include detect debug diagnostics when available.
+         * @summary Detect element coordinates using vision with optional smart targeting
          * @param {string} browserId
          * @param {DetectCoordinatesRequest} payload
          * @param {*} [options] Override http request option.
@@ -2220,8 +2322,8 @@ const BrowserApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUrl(browserId, options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary GUI click by selector or coordinates
+         * Selector mode uses `selector` with optional `fx` / `fy` offsets. Coordinate mode uses `x` / `y` and supports smart targeting knobs such as `pre_click_validate`, `auto_snap`, and `post_click_feedback`.  Recommended agent mode: - `pre_click_validate=\"strict\"` - `auto_snap=\"nearest_clickable\"` - `post_click_feedback=\"auto\"`  MCP keeps `gui_click_xy` as a compatibility alias for coordinate-mode `gui_click`.
+         * @summary GUI click by selector or coordinates with smart validation
          * @param {string} browserId
          * @param {GuiClickRequest} payload
          * @param {*} [options] Override http request option.
@@ -2230,6 +2332,17 @@ const BrowserApiFactory = function (configuration, basePath, axios) {
         guiClick(browserId, payload, options) {
             return localVarFp.guiClick(browserId, payload, options).then((request) => request(axios, basePath));
         },
+        /**
+         * This mirrors coordinate-mode `gui_click`, accepts the same smart-click options, and returns the same response contract.
+         * @summary MCP compatibility alias for coordinate-mode `gui_click`
+         * @param {string} browserId
+         * @param {GuiClickXYRequest} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        guiClickXy(browserId, payload, options) {
+            return localVarFp.guiClickXy(browserId, payload, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary GUI hover at coordinates
@@ -2432,11 +2545,12 @@ const BrowserApiFactory = function (configuration, basePath, axios) {
          *
          * @summary AI page analysis - what\'s visible
          * @param {string} browserId
+         * @param {WhatIsVisibleRequest} payload
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        whatIsVisible(browserId, options) {
-            return localVarFp.whatIsVisible(browserId, options).then((request) => request(axios, basePath));
+        whatIsVisible(browserId, payload, options) {
+            return localVarFp.whatIsVisible(browserId, payload, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -2522,8 +2636,8 @@ class BrowserApi extends base_1.BaseAPI {
         return (0, exports.BrowserApiFp)(this.configuration).createBrowser(payload, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Args:     browser_id: Browser instance identifier     prompt: Natural language description of element to find     fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right).         If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10).     fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
-     * @summary Detect element coordinates using vision
+     * Args:     browser_id: Browser instance identifier     prompt: Natural language description of element to find     fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right).         If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10).     fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).     model: Optional vision model override for this request.     stream: Optional vision streaming override for this request.     hit_test: Detect-time validation mode: off, warn, or strict.         Recommended for agents: `strict`.     auto_snap: Auto-snap mode: off, nearest_clickable, or nearest_interactive.         Recommended for agents: `nearest_clickable`.     snap_radius: Maximum snap radius in CSS pixels.     include_debug: Include detect debug diagnostics when available.
+     * @summary Detect element coordinates using vision with optional smart targeting
      * @param {string} browserId
      * @param {DetectCoordinatesRequest} payload
      * @param {*} [options] Override http request option.
@@ -2632,8 +2746,8 @@ class BrowserApi extends base_1.BaseAPI {
         return (0, exports.BrowserApiFp)(this.configuration).getUrl(browserId, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary GUI click by selector or coordinates
+     * Selector mode uses `selector` with optional `fx` / `fy` offsets. Coordinate mode uses `x` / `y` and supports smart targeting knobs such as `pre_click_validate`, `auto_snap`, and `post_click_feedback`.  Recommended agent mode: - `pre_click_validate=\"strict\"` - `auto_snap=\"nearest_clickable\"` - `post_click_feedback=\"auto\"`  MCP keeps `gui_click_xy` as a compatibility alias for coordinate-mode `gui_click`.
+     * @summary GUI click by selector or coordinates with smart validation
      * @param {string} browserId
      * @param {GuiClickRequest} payload
      * @param {*} [options] Override http request option.
@@ -2642,6 +2756,17 @@ class BrowserApi extends base_1.BaseAPI {
     guiClick(browserId, payload, options) {
         return (0, exports.BrowserApiFp)(this.configuration).guiClick(browserId, payload, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * This mirrors coordinate-mode `gui_click`, accepts the same smart-click options, and returns the same response contract.
+     * @summary MCP compatibility alias for coordinate-mode `gui_click`
+     * @param {string} browserId
+     * @param {GuiClickXYRequest} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    guiClickXy(browserId, payload, options) {
+        return (0, exports.BrowserApiFp)(this.configuration).guiClickXy(browserId, payload, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary GUI hover at coordinates
@@ -2844,11 +2969,12 @@ class BrowserApi extends base_1.BaseAPI {
      *
      * @summary AI page analysis - what\'s visible
      * @param {string} browserId
+     * @param {WhatIsVisibleRequest} payload
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    whatIsVisible(browserId, options) {
-        return (0, exports.BrowserApiFp)(this.configuration).whatIsVisible(browserId, options).then((request) => request(this.axios, this.basePath));
+    whatIsVisible(browserId, payload, options) {
+        return (0, exports.BrowserApiFp)(this.configuration).whatIsVisible(browserId, payload, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.BrowserApi = BrowserApi;