@airtop/sdk 0.1.18 → 0.1.26-beta0

package/api/types/Proxy.d.ts

@@ -1,11 +1,14 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Airtop from "../index";
 /**
- * Proxy object with url of the proxy as a parameter. Takes optional username and password.
+ * Configuration for a single custom proxy.
  */
-export interface Proxy {
-    password?: string;
-    url: string;
-    username?: string;
-}
+export declare type Proxy = 
+/**
+ * Url of the proxy. Or `default` to use Airtop-provided proxy. */
+string | Airtop.AirtopProxyConfiguration
+/**
+ * Proxy object with url of the proxy as a parameter. Takes optional username and password. */
+ | Airtop.ProxyCredentials;

package/api/types/ProxyConfigurationKind.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Airtop from "../index";
+export interface ProxyConfigurationKind {
+    domainPattern: string;
+    /** Configuration for a single custom proxy. */
+    relay: Airtop.Proxy;
+}

package/api/types/ProxyConfigurationKind.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProxyCredentials.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Proxy object with url of the proxy as a parameter. Takes optional username and password.
+ */
+export interface ProxyCredentials {
+    password?: string;
+    url: string;
+    username?: string;
+}

package/api/types/ProxyCredentials.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/RequestStatusResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RequestStatusResponse {
+    response?: unknown;
+    /** The current status of the request (pending, completed, error) */
+    status: string;
+}

package/api/types/RequestStatusResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ScrapeConfig.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ScrapeConfig {
+    /** URL optimization helps improve performance during model analysis, but limits the model's ability to analyze internal details of URLs (such as individual URL parameters). This setting does not affect the ability to extract URLs or links from web pages -- those will work regardless of how this option is set. However, if you need to analyze URLs themselves and are not getting satisfactory results, try setting this option to 'disabled'. If set to 'auto', Airtop AI will automatically determine whether to apply URL optimization. If 'enabled', URLs will always be optimized to improve performance. If 'disabled', URLs will not be optimized. */
+    optimizeUrls?: string;
+}

package/api/types/ScrapeConfig.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ScrollByConfig.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ScrollByConfig {
+    /** The amount of pixels/percentage to scroll horizontally. Percentage values should be between 0 and 100. Positive values scroll right, negative values scroll left. */
+    xAxis?: string;
+    /** The amount of pixels/percentage to scroll vertically. Percentage values should be between 0 and 100. Positive values scroll down, negative values scroll up. */
+    yAxis?: string;
+}

package/api/types/ScrollByConfig.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ScrollToEdgeConfig.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ScrollToEdgeConfig {
+    /** Scroll to the left or right of the page. */
+    xAxis?: string;
+    /** Scroll to the top or bottom of the page. */
+    yAxis?: string;
+}

package/api/types/ScrollToEdgeConfig.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SessionConfigV1.d.ts

@@ -5,12 +5,16 @@ import * as Airtop from "../index";
 export interface SessionConfigV1 {
     /** Deprecated: Use profileName instead. */
     baseProfileId?: string;
+    /** Name of an extension configuration to load into the session. */
+    extensionConfigurationName?: string;
+    /** Google Web Store extension IDs to be loaded into the session. */
+    extensionIds?: string[];
     /** Deprecated: use Save Profile On Termination API instead. */
     persistProfile?: boolean;
     /** Name of a profile to load into the session. */
     profileName?: string;
     /** Proxy configuration. */
     proxy?: Airtop.SessionConfigV1Proxy;
-    /** Max length of session in minutes, after which it will terminate if not already deleted. */
+    /** Number of minutes of inactivity (idle timeout) after which the session will terminate. The idle timeout is reset when a user makes an incoming HTTP request, AI request, or new WebSocket connection to the session. Thus, when using drivers like Puppeteer, Selenium or Playwright, the timeout reset depends on the nature of the driver request. If not specified, defaults to 10 minutes. */
     timeoutMinutes?: number;
 }

package/api/types/SessionConfigV1Proxy.d.ts

@@ -7,11 +7,11 @@ import * as Airtop from "../index";
  */
 export declare type SessionConfigV1Proxy = 
 /**
- * True to use airtop provided proxy */
+ * Use Airtop-provided proxy. */
 boolean
 /**
  * Configuration for a single custom proxy. */
- | Airtop.CustomProxy
+ | Airtop.Proxy
 /**
- * Array of proxy configurations. Includes a domain pattern and a proxy configuration to assign proxies to specific domains. */
- | Airtop.SessionConfigV1ProxyItem[];
+ * You can set multiple proxies. You associate each proxy with a domain pattern. If the domain matches the pattern, the proxy is used. Pattern can contain `?` to match any single character and / or `*` to match any sequence of characters. For example, `*.example.com` will match `www.example.com` and `sub.example.com`. */
+ | Airtop.ProxyConfigurationKind[];

package/api/types/VisualAnalysisConfig.d.ts

@@ -9,7 +9,7 @@ export interface VisualAnalysisConfig {
     overlapPercentage?: number;
     /** The direction to partition the screenshot into chunks: 'vertical', 'horizontal', or 'bidirectional'. Defaults to 'vertical', which is recommended for most web pages. For optimal results when partitioning in a single direction, ensure the perpendicular dimension does not exceed 1920 pixels. */
     partitionDirection?: Airtop.VisualAnalysisConfigPartitionDirection;
-    /** [Experimental] The strategy to use for selecting the match using visual analysis. Can be 'first' or bestMatch'. Defaults to 'first'. Use 'first' to select the first visual element that matches the element description. This will favor results that appear higher on the page in the event of multiple matches. Use 'bestMatch' to perform a second round of analysis to select the result that best matches the element description. */
+    /** [Experimental] The strategy to use for selecting the match using visual analysis. Can be 'auto', 'first' or 'bestMatch'. Defaults to 'auto'. Use 'auto' to let the system decide the best strategy. Use 'first' to select the first visual element that matches the element description. This will favor results that appear higher on the page in the event of multiple matches. Use 'bestMatch' to analyze the complete page and apply judgement to select the best candidate from all potential matches. */
     resultSelectionStrategy?: Airtop.VisualAnalysisConfigResultSelectionStrategy;
     /** Scan mode only: The delay between scrolls in milliseconds. Defaults to 1000 (milliseconds). */
     scanScrollDelay?: number;

package/api/types/VisualAnalysisConfigResultSelectionStrategy.d.ts

@@ -2,10 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * [Experimental] The strategy to use for selecting the match using visual analysis. Can be 'first' or bestMatch'. Defaults to 'first'. Use 'first' to select the first visual element that matches the element description. This will favor results that appear higher on the page in the event of multiple matches. Use 'bestMatch' to perform a second round of analysis to select the result that best matches the element description.
+ * [Experimental] The strategy to use for selecting the match using visual analysis. Can be 'auto', 'first' or 'bestMatch'. Defaults to 'auto'. Use 'auto' to let the system decide the best strategy. Use 'first' to select the first visual element that matches the element description. This will favor results that appear higher on the page in the event of multiple matches. Use 'bestMatch' to analyze the complete page and apply judgement to select the best candidate from all potential matches.
  */
-export declare type VisualAnalysisConfigResultSelectionStrategy = "first" | "bestMatch";
+export declare type VisualAnalysisConfigResultSelectionStrategy = "first" | "bestMatch" | "auto";
 export declare const VisualAnalysisConfigResultSelectionStrategy: {
     readonly First: "first";
     readonly BestMatch: "bestMatch";
+    readonly Auto: "auto";
 };

package/api/types/VisualAnalysisConfigResultSelectionStrategy.js

@@ -7,4 +7,5 @@ exports.VisualAnalysisConfigResultSelectionStrategy = void 0;
 exports.VisualAnalysisConfigResultSelectionStrategy = {
     First: "first",
     BestMatch: "bestMatch",
+    Auto: "auto",
 };

package/api/types/Window.d.ts

@@ -4,6 +4,8 @@
 export interface Window {
     /** Url for loading a browser window live view that is configured according to the request options like screenResolution, disableResize, etc. */
     liveViewUrl: string;
+    /** CDP target ID of the browser window */
+    targetId: string;
     /** Airtop window ID of the browser window */
     windowId: string;
 }

package/api/types/index.d.ts

@@ -1,7 +1,10 @@
 export * from "./AiPromptResponse";
 export * from "./AiResponseEnvelope";
+export * from "./AsyncConfig";
+export * from "./AsyncSessionAiResponseEnvelope";
 export * from "./BrowserWaitNavigationConfigWaitUntil";
 export * from "./BrowserWaitNavigationConfig";
+export * from "./BrowserWaitSelectorConfig";
 export * from "./ClickConfigClickType";
 export * from "./ClickConfig";
 export * from "./ClientProvidedResponseMetadata";
@@ -10,19 +13,26 @@ export * from "./ErrorBody";
 export * from "./ErrorDetail";
 export * from "./ErrorMessage";
 export * from "./ErrorModel";
+export * from "./ExtensionConfigurationOutput";
 export * from "./ExternalSessionAiResponseMetadataStatus";
 export * from "./ExternalSessionAiResponseMetadata";
 export * from "./ExternalSessionAiResponseMetadataUsage";
 export * from "./ExternalSessionConfig";
 export * from "./ExternalSessionWithConnectionInfo";
+export * from "./IntervalMonitorConfig";
 export * from "./Issue";
 export * from "./MicroInteractionConfig";
+export * from "./MonitorConfigIncludeVisualAnalysis";
+export * from "./MonitorConfigMonitorType";
+export * from "./MonitorConfig";
 export * from "./OperationOutcome";
 export * from "./OperationOutcomeResponse";
 export * from "./PageQueryConfig";
 export * from "./PageQueryExperimentalConfig";
 export * from "./PaginatedExtractionConfig";
 export * from "./Pagination";
+export * from "./RequestStatusResponse";
+export * from "./ScrapeConfig";
 export * from "./ScrapeResponse";
 export * from "./ScrapeResponseContent";
 export * from "./ScrapeResponseEnvelope";
@@ -30,9 +40,12 @@ export * from "./ScrapeResponseOutput";
 export * from "./ScreenshotConfig";
 export * from "./ScreenshotMetadata";
 export * from "./ScreenshotRequestConfig";
+export * from "./ScrollByConfig";
+export * from "./ScrollToEdgeConfig";
+export * from "./AirtopProxyConfiguration";
+export * from "./ProxyCredentials";
 export * from "./Proxy";
-export * from "./CustomProxy";
-export * from "./SessionConfigV1ProxyItem";
+export * from "./ProxyConfigurationKind";
 export * from "./SessionConfigV1Proxy";
 export * from "./SessionConfigV1";
 export * from "./SessionEventMessage";

package/api/types/index.js

@@ -16,8 +16,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AiPromptResponse"), exports);
 __exportStar(require("./AiResponseEnvelope"), exports);
+__exportStar(require("./AsyncConfig"), exports);
+__exportStar(require("./AsyncSessionAiResponseEnvelope"), exports);
 __exportStar(require("./BrowserWaitNavigationConfigWaitUntil"), exports);
 __exportStar(require("./BrowserWaitNavigationConfig"), exports);
+__exportStar(require("./BrowserWaitSelectorConfig"), exports);
 __exportStar(require("./ClickConfigClickType"), exports);
 __exportStar(require("./ClickConfig"), exports);
 __exportStar(require("./ClientProvidedResponseMetadata"), exports);
@@ -26,19 +29,26 @@ __exportStar(require("./ErrorBody"), exports);
 __exportStar(require("./ErrorDetail"), exports);
 __exportStar(require("./ErrorMessage"), exports);
 __exportStar(require("./ErrorModel"), exports);
+__exportStar(require("./ExtensionConfigurationOutput"), exports);
 __exportStar(require("./ExternalSessionAiResponseMetadataStatus"), exports);
 __exportStar(require("./ExternalSessionAiResponseMetadata"), exports);
 __exportStar(require("./ExternalSessionAiResponseMetadataUsage"), exports);
 __exportStar(require("./ExternalSessionConfig"), exports);
 __exportStar(require("./ExternalSessionWithConnectionInfo"), exports);
+__exportStar(require("./IntervalMonitorConfig"), exports);
 __exportStar(require("./Issue"), exports);
 __exportStar(require("./MicroInteractionConfig"), exports);
+__exportStar(require("./MonitorConfigIncludeVisualAnalysis"), exports);
+__exportStar(require("./MonitorConfigMonitorType"), exports);
+__exportStar(require("./MonitorConfig"), exports);
 __exportStar(require("./OperationOutcome"), exports);
 __exportStar(require("./OperationOutcomeResponse"), exports);
 __exportStar(require("./PageQueryConfig"), exports);
 __exportStar(require("./PageQueryExperimentalConfig"), exports);
 __exportStar(require("./PaginatedExtractionConfig"), exports);
 __exportStar(require("./Pagination"), exports);
+__exportStar(require("./RequestStatusResponse"), exports);
+__exportStar(require("./ScrapeConfig"), exports);
 __exportStar(require("./ScrapeResponse"), exports);
 __exportStar(require("./ScrapeResponseContent"), exports);
 __exportStar(require("./ScrapeResponseEnvelope"), exports);
@@ -46,9 +56,12 @@ __exportStar(require("./ScrapeResponseOutput"), exports);
 __exportStar(require("./ScreenshotConfig"), exports);
 __exportStar(require("./ScreenshotMetadata"), exports);
 __exportStar(require("./ScreenshotRequestConfig"), exports);
+__exportStar(require("./ScrollByConfig"), exports);
+__exportStar(require("./ScrollToEdgeConfig"), exports);
+__exportStar(require("./AirtopProxyConfiguration"), exports);
+__exportStar(require("./ProxyCredentials"), exports);
 __exportStar(require("./Proxy"), exports);
-__exportStar(require("./CustomProxy"), exports);
-__exportStar(require("./SessionConfigV1ProxyItem"), exports);
+__exportStar(require("./ProxyConfigurationKind"), exports);
 __exportStar(require("./SessionConfigV1Proxy"), exports);
 __exportStar(require("./SessionConfigV1"), exports);
 __exportStar(require("./SessionEventMessage"), exports);

package/biome.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "javascript": {
+    "formatter": {
+      "enabled": true,
+      "quoteStyle": "single"
+    }
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "lineWidth": 120,
+    "ignore": [
+      "node_modules/**",
+      ".idea/**",
+      "dist/**",
+      "src/api/**",
+      "src/core/**",
+      "src/errors/**",
+      "src/serialization/**",
+      "src/Client.ts",
+      "src/environments.ts",
+      "src/index.ts",
+      "tests/**"
+    ],
+    "include": ["src/wrapper/**", "src/utils/**", "src/live-view/**"]
+  },
+  "linter": {
+    "ignore": [
+      "node_modules/**",
+      ".idea/**",
+      "dist/**",
+      "src/api/**",
+      "src/core/**",
+      "src/errors/**",
+      "src/serialization/**",
+      "src/Client.ts",
+      "src/environments.ts",
+      "src/index.ts",
+      "tests/**"
+    ],
+    "include": ["src/wrapper/**", "src/utils/**", "src/live-view/**"],
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "noUnusedImports": "error",
+        "useExhaustiveDependencies": "error"
+      },
+      "suspicious": {
+        "noImplicitAnyLet": "off",
+        "noExplicitAny": "off",
+        "noDebugger": {
+          "level": "warn",
+          "fix": "none"
+        },
+        "noAssignInExpressions": "warn"
+      },
+      "nursery": {
+        "useSortedClasses": "warn"
+      }
+    }
+  }
+}

package/config/tsconfig-nobase.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "strict": true,
+        "target": "ES6",
+        "module": "CommonJS",
+        "moduleResolution": "node",
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "declaration": true,
+        "outDir": "../dist",
+        "rootDir": "../src",
+        "noEmit": true
+    },
+    "include": ["../src"],
+    "exclude": []
+}

package/dist/Client.d.ts

@@ -4,7 +4,9 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import { Windows } from "./api/resources/windows/client/Client";
+import { ExtensionConfigurations } from "./api/resources/extensionConfigurations/client/Client";
 import { Profiles } from "./api/resources/profiles/client/Client";
+import { Requests } from "./api/resources/requests/client/Client";
 import { Sessions } from "./api/resources/sessions/client/Client";
 export declare namespace AirtopClient {
     interface Options {
@@ -26,8 +28,12 @@ export declare class AirtopClient {
     constructor(_options: AirtopClient.Options);
     protected _windows: Windows | undefined;
     get windows(): Windows;
+    protected _extensionConfigurations: ExtensionConfigurations | undefined;
+    get extensionConfigurations(): ExtensionConfigurations;
     protected _profiles: Profiles | undefined;
     get profiles(): Profiles;
+    protected _requests: Requests | undefined;
+    get requests(): Requests;
     protected _sessions: Sessions | undefined;
     get sessions(): Sessions;
 }

package/dist/Client.js

@@ -5,8 +5,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AirtopClient = void 0;
 const Client_1 = require("./api/resources/windows/client/Client");
-const Client_2 = require("./api/resources/profiles/client/Client");
-const Client_3 = require("./api/resources/sessions/client/Client");
+const Client_2 = require("./api/resources/extensionConfigurations/client/Client");
+const Client_3 = require("./api/resources/profiles/client/Client");
+const Client_4 = require("./api/resources/requests/client/Client");
+const Client_5 = require("./api/resources/sessions/client/Client");
 class AirtopClient {
     constructor(_options) {
         this._options = _options;
@@ -15,13 +17,21 @@ class AirtopClient {
         var _a;
         return ((_a = this._windows) !== null && _a !== void 0 ? _a : (this._windows = new Client_1.Windows(this._options)));
     }
+    get extensionConfigurations() {
+        var _a;
+        return ((_a = this._extensionConfigurations) !== null && _a !== void 0 ? _a : (this._extensionConfigurations = new Client_2.ExtensionConfigurations(this._options)));
+    }
     get profiles() {
         var _a;
-        return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_2.Profiles(this._options)));
+        return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_3.Profiles(this._options)));
+    }
+    get requests() {
+        var _a;
+        return ((_a = this._requests) !== null && _a !== void 0 ? _a : (this._requests = new Client_4.Requests(this._options)));
     }
     get sessions() {
         var _a;
-        return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_3.Sessions(this._options)));
+        return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_5.Sessions(this._options)));
     }
 }
 exports.AirtopClient = AirtopClient;

package/dist/api/resources/extensionConfigurations/client/Client.d.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Airtop from "../../../index";
+export declare namespace ExtensionConfigurations {
+    interface Options {
+        environment?: core.Supplier<environments.AirtopEnvironment | string>;
+        apiKey: core.Supplier<core.BearerToken>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class ExtensionConfigurations {
+    protected readonly _options: ExtensionConfigurations.Options;
+    constructor(_options: ExtensionConfigurations.Options);
+    /**
+     * Delete extension configurations matching by name
+     *
+     * @param {Airtop.ExtensionConfigurationDeleteRequest} request
+     * @param {ExtensionConfigurations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.extensionConfigurations.extensionConfigurationDelete()
+     */
+    extensionConfigurationDelete(request?: Airtop.ExtensionConfigurationDeleteRequest, requestOptions?: ExtensionConfigurations.RequestOptions): Promise<void>;
+    /**
+     * Get an extension configuration by name
+     *
+     * @param {string} name - Name of the extension configuration to get
+     * @param {ExtensionConfigurations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Airtop.NotFoundError}
+     * @throws {@link Airtop.UnprocessableEntityError}
+     * @throws {@link Airtop.InternalServerError}
+     *
+     * @example
+     *     await client.extensionConfigurations.extensionConfigurationGetInfo("my-configuration")
+     */
+    extensionConfigurationGetInfo(name: string, requestOptions?: ExtensionConfigurations.RequestOptions): Promise<Airtop.ExtensionConfigurationOutput>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}