@airtop/sdk 1.0.0-alpha2.6 → 1.0.0-alpha2.8

package/dist/index.d.ts

@@ -11,7 +11,7 @@ import * as _airtop_core_resources_shared_js from '@airtop/core/resources/shared
 import { SessionConfigV1, GetFileResponse, FilesResponse, ListAutomationsOutput, AutomationData, ExternalSessionWithConnectionInfo, EnvelopeDefaultMeta, Issue, AIPromptResponse as AIPromptResponse$1, WindowIDDataResponse, OperationOutcomeResponse } from '@airtop/core/resources/shared.js';
 export { AIResponseEnvelope, AirtopPagination, ExternalSessionAIResponseMetadata, ExternalSessionWithConnectionInfo, Issue, OperationOutcomeResponse, WindowIDDataResponse } from '@airtop/core/resources/shared.js';
 import * as _airtop_core_resources_sessions_mjs from '@airtop/core/resources/sessions.mjs';
-import { WindowClickParams, WindowHoverParams, WindowLoadURLParams, WindowMonitorParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams } from '@airtop/core/resources/windows.js';
+import { WindowClickParams, WindowHoverParams, WindowLoadURLParams, WindowMonitorParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowExtractParams, WindowActParams, WindowLlmParams, WindowFindOneParams, WindowFindManyParams } from '@airtop/core/resources/windows.js';
 
 /**
  * Shared configuration between Airtop classes.
@@ -36,6 +36,10 @@ interface CommonAirtopConfig {
      * Used for customizing output schema handling.
      */
     outputSchemaAdapter?: AirtopJsonSchemaAdapter;
+    /**
+     * The automation job ID to use for the request.
+     */
+    jobId?: string;
 }
 /**
  * Configuration for defining the JSON schema output.
@@ -97,6 +101,11 @@ declare class AirtopBase {
      * @internal
      **/
     protected outputJsonAdapter: AirtopJsonSchemaAdapter;
+    /**
+     * The job id for the ongoing automation
+     * @internal
+     */
+    protected jobId?: string;
     /**
      * Creates a new instance of AirtopBase
      * @param config - Configuration options for the SDK
@@ -180,6 +189,10 @@ interface AirtopConstructorConfig {
      * Used to customize how response data is structured.
      */
     outputSchemaAdapter?: AirtopJsonSchemaAdapter;
+    /**
+     * The job ID to use for the ongoing automation.
+     */
+    jobId?: string;
 }
 /**
  * Configuration options for creating a new session.
@@ -348,6 +361,51 @@ interface AirtopWindowGetInfoResponse extends AirtopWindowCreateResponse {
     data: WindowInfoData;
 }
 
+declare class AirtopNodeImpl {
+    /**
+     * The window client
+     */
+    protected windowClient: AirtopWindowClient;
+    /**
+     * The node handle id to use for all requests
+     */
+    protected nodeHandleId: string;
+    /**
+     * Constructor
+     * @param client - The window client
+     * @param nodeHandleId - The node handle id to use for all requests
+     */
+    constructor(client: AirtopWindowClient, nodeHandleId: string);
+    /**
+     * Extract content from the node
+     * @param prompt - The prompt to use for the extraction
+     * @param config - The configuration to use for the extraction
+     * @param requestOptions - The request options to use for the extraction
+     */
+    extract(prompt: string, config?: WindowExtractConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Act on the node
+     * @param prompt - The prompt to use for the action
+     * @param config - The configuration to use for the action
+     * @param requestOptions - The request options to use for the action
+     */
+    act(prompt: string, config?: WindowActConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Execute an LLM call on the node
+     * @param prompt - The prompt to use for the LLM call
+     * @param config - The configuration to use for the LLM call
+     * @param requestOptions - The request options to use for the LLM call
+     */
+    llm(prompt: string, config?: WindowLlmConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    /**
+     * Find one element in the node
+     * @param prompt - The prompt to use for the find one
+     * @param config - The configuration to use for the find one
+     * @param requestOptions - The request options to use for the find one
+     */
+    findOne(prompt: string, config?: WindowFindOneConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopNode>;
+}
+
 /**
  * Configuration parameters for typing text in a window.
  * Excludes session ID and text content which are provided separately.
@@ -422,6 +480,36 @@ interface WindowPromptResponse extends AIPromptResponse {
  */
 interface WindowScrapeResponse extends ScrapeResponse {
 }
+/**
+ * Configuration parameters for extracting content from a window.
+ */
+interface WindowExtractConfig extends Omit<WindowExtractParams, "sessionId" | "prompt" | "jobId"> {
+}
+/**
+ * Configuration parameters for acting on content in a window.
+ */
+interface WindowActConfig extends Omit<WindowActParams, "sessionId" | "prompt" | "jobId"> {
+}
+/**
+ * Configuration parameters for executing an LLM call in a window.
+ */
+interface WindowLlmConfig extends Omit<WindowLlmParams, "sessionId" | "prompt"> {
+}
+/**
+ * Configuration parameters for finding one element in a window.
+ */
+interface WindowFindOneConfig extends Omit<WindowFindOneParams, "sessionId" | "prompt" | "jobId"> {
+}
+/**
+ * Configuration parameters for finding multiple elements in a window.
+ */
+interface WindowFindManyConfig extends Omit<WindowFindManyParams, "sessionId" | "prompt" | "jobId"> {
+}
+/**
+ * Response for finding one element in a window.
+ */
+interface AirtopNode extends AirtopNodeImpl {
+}
 
 /**
  * Response object for a screenshot operation.
@@ -467,7 +555,7 @@ declare class AirtopWindowScreenshot {
     };
 }
 
-/**
+/**, waitForRequestCompletion
  * Client for making window-specific requests to the Airtop API.
  */
 declare class AirtopWindowClient extends AirtopBase {
@@ -585,6 +673,11 @@ declare class AirtopWindowClient extends AirtopBase {
      * @returns Promise resolving when the text has been typed
      */
     type(text: string, config?: WindowTypeConfig, requestOptions?: AirtopRequestOptions): Promise<_airtop_core_resources_shared_mjs.AIPromptResponse>;
+    extract(prompt: string, config?: WindowExtractConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    act(prompt: string, config?: WindowActConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    llm(prompt: string, config?: WindowLlmConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    findOne(prompt: string, config?: WindowFindOneConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopNode>;
+    findMany(prompt: string, config?: WindowFindManyConfig, requestOptions?: AirtopRequestOptions): Promise<AirtopNode[]>;
 }
 
 /**
@@ -1025,4 +1118,4 @@ declare class AirtopMocks {
     }): AirtopWindow<AirtopWindowGetInfoResponse>;
 }
 
-export { type AirtopAutomationData, type AirtopAutomationListResponse, type AirtopAutomationUpdateDescriptionConfig, AirtopBase, AirtopClient, type AirtopClientPlugin, type AirtopConstructorConfig, type AirtopFileListParams, type AirtopFileResponse, type AirtopFilesResponse, AirtopMocks, AirtopPluginAugmentationType, type AirtopPluginRegistration, type AirtopPluginType, type AirtopProfile, type AirtopRequestOptions, AirtopSession, AirtopSessionClient, type AirtopSessionClientPlugin, type AirtopSessionPlugin, type AirtopSessionResponse, AirtopWindow, AirtopWindowClient, type AirtopWindowClientPlugin, type AirtopWindowCreateResponse, type AirtopWindowGetInfoResponse, type AirtopWindowPlugin, AirtopWindowScreenshot, type AirtopWindowScreenshotPlugin, type AirtopWindowScreenshotResponse, type CommonAirtopConfig, type CommonResponse, type CommonWindowResponse, type CreateFileConfig, type CreateSessionConfig, type GetFilesConfig, type GetSessionsConfig, type OutputJsonSchemaConfig, type ScreenshotData, type SessionData, type SessionError, type SessionMetadata, type SessionWarning, type WindowClickConfig, type WindowCreateData, type WindowError, type WindowGetConfig, type WindowHoverConfig, type WindowInfoData, type WindowLoadUrlConfig, type WindowMetadata, type WindowMonitorConfig, type WindowPageQueryConfig, type WindowPaginatedExtractionConfig, type WindowPromptResponse, type WindowScrapeConfig, type WindowScrapeResponse, type WindowScreenshotConfig, type WindowScrollConfig, type WindowTypeConfig, type WindowWarning, registerAirtopPlugin };
+export { type AirtopAutomationData, type AirtopAutomationListResponse, type AirtopAutomationUpdateDescriptionConfig, AirtopBase, AirtopClient, type AirtopClientPlugin, type AirtopConstructorConfig, type AirtopFileListParams, type AirtopFileResponse, type AirtopFilesResponse, AirtopMocks, type AirtopNode, AirtopPluginAugmentationType, type AirtopPluginRegistration, type AirtopPluginType, type AirtopProfile, type AirtopRequestOptions, AirtopSession, AirtopSessionClient, type AirtopSessionClientPlugin, type AirtopSessionPlugin, type AirtopSessionResponse, AirtopWindow, AirtopWindowClient, type AirtopWindowClientPlugin, type AirtopWindowCreateResponse, type AirtopWindowGetInfoResponse, type AirtopWindowPlugin, AirtopWindowScreenshot, type AirtopWindowScreenshotPlugin, type AirtopWindowScreenshotResponse, type CommonAirtopConfig, type CommonResponse, type CommonWindowResponse, type CreateFileConfig, type CreateSessionConfig, type GetFilesConfig, type GetSessionsConfig, type OutputJsonSchemaConfig, type ScreenshotData, type SessionData, type SessionError, type SessionMetadata, type SessionWarning, type WindowActConfig, type WindowClickConfig, type WindowCreateData, type WindowError, type WindowExtractConfig, type WindowFindManyConfig, type WindowFindOneConfig, type WindowGetConfig, type WindowHoverConfig, type WindowInfoData, type WindowLlmConfig, type WindowLoadUrlConfig, type WindowMetadata, type WindowMonitorConfig, type WindowPageQueryConfig, type WindowPaginatedExtractionConfig, type WindowPromptResponse, type WindowScrapeConfig, type WindowScrapeResponse, type WindowScreenshotConfig, type WindowScrollConfig, type WindowTypeConfig, type WindowWarning, registerAirtopPlugin };

package/dist/index.js

@@ -9,7 +9,7 @@ var require_package = __commonJS({
     module.exports = {
       name: "@airtop/sdk",
       description: "Airtop SDK for TypeScript",
-      version: "1.0.0-alpha2.6",
+      version: "1.0.0-alpha2.8",
       type: "module",
       main: "./dist/index.cjs",
       module: "./dist/index.js",
@@ -47,7 +47,7 @@ var require_package = __commonJS({
       },
       dependencies: {
         "@airtop/json-schema-adapter": "workspace:*",
-        "@airtop/core": "0.1.0-alpha.24",
+        "@airtop/core": "0.1.0-alpha.26",
         "date-fns": "4.1.0",
         loglayer: "6.3.3",
         "serialize-error": "12.0.0",
@@ -102,6 +102,11 @@ var AirtopBase = class {
    * @internal
    **/
   outputJsonAdapter;
+  /**
+   * The job id for the ongoing automation
+   * @internal
+   */
+  jobId;
   /**
    * Creates a new instance of AirtopBase
    * @param config - Configuration options for the SDK
@@ -110,6 +115,7 @@ var AirtopBase = class {
     this.log = config.log.withPrefix("[Airtop]");
     this.client = config.client;
     this.outputJsonAdapter = config.outputSchemaAdapter;
+    this.jobId = config.jobId;
   }
   /**
    * Returns the API key used by the SDK
@@ -163,7 +169,8 @@ var AirtopBase = class {
   getCommonConfig() {
     return {
       client: this.client,
-      log: this.log
+      log: this.log,
+      jobId: this.jobId
     };
   }
   /**
@@ -235,7 +242,100 @@ var processLogMessage = (log, logLevel, ...args) => {
 import { NotFoundError } from "@airtop/core";
 
 // src/window/AirtopWindowClient.ts
+import { secondsToMilliseconds as secondsToMilliseconds3 } from "date-fns";
+
+// src/async-utils.ts
 import { secondsToMilliseconds as secondsToMilliseconds2 } from "date-fns";
+var DEFAULT_TIMEOUT_SECONDS = 300;
+var DEFAULT_POLLING_INTERVAL_SECONDS = 2;
+async function waitForRequestCompletion(client, requestId, requestOptions) {
+  const startTime = Date.now();
+  const timeoutMs = secondsToMilliseconds2(requestOptions?.timeoutInSeconds || DEFAULT_TIMEOUT_SECONDS);
+  while (Date.now() - startTime < timeoutMs) {
+    const apiResponse = await client.requests.getRequestStatus(requestId, requestOptions);
+    if (apiResponse.status === "completed") {
+      return apiResponse.response;
+    }
+    if (apiResponse.status === "error") {
+      throw new Error(apiResponse.error);
+    }
+    await new Promise((resolve) => setTimeout(resolve, secondsToMilliseconds2(DEFAULT_POLLING_INTERVAL_SECONDS)));
+  }
+  throw new Error("Waiting for request timed out");
+}
+async function withRequestCompletionPolling(client, fn, requestOptions) {
+  const response = await fn();
+  return waitForRequestCompletion(client, response.requestId, requestOptions);
+}
+
+// src/window/AirtopNode.ts
+var AirtopNodeImpl = class {
+  /**
+   * The window client
+   */
+  windowClient;
+  /**
+   * The node handle id to use for all requests
+   */
+  nodeHandleId;
+  /**
+   * Constructor
+   * @param client - The window client
+   * @param nodeHandleId - The node handle id to use for all requests
+   */
+  constructor(client, nodeHandleId) {
+    this.windowClient = client;
+    this.nodeHandleId = nodeHandleId;
+  }
+  /**
+   * Extract content from the node
+   * @param prompt - The prompt to use for the extraction
+   * @param config - The configuration to use for the extraction
+   * @param requestOptions - The request options to use for the extraction
+   */
+  async extract(prompt, config, requestOptions = {}) {
+    const augmentedConfig = {
+      ...config,
+      nodeHandleId: this.nodeHandleId
+    };
+    return this.windowClient.extract(prompt, augmentedConfig, requestOptions);
+  }
+  /**
+   * Act on the node
+   * @param prompt - The prompt to use for the action
+   * @param config - The configuration to use for the action
+   * @param requestOptions - The request options to use for the action
+   */
+  async act(prompt, config, requestOptions = {}) {
+    const augmentedConfig = {
+      ...config,
+      nodeHandleId: this.nodeHandleId
+    };
+    return this.windowClient.act(prompt, augmentedConfig, requestOptions);
+  }
+  /**
+   * Execute an LLM call on the node
+   * @param prompt - The prompt to use for the LLM call
+   * @param config - The configuration to use for the LLM call
+   * @param requestOptions - The request options to use for the LLM call
+   */
+  async llm(prompt, config, requestOptions = {}) {
+    return this.windowClient.llm(prompt, config, requestOptions);
+  }
+  /**
+   * Find one element in the node
+   * @param prompt - The prompt to use for the find one
+   * @param config - The configuration to use for the find one
+   * @param requestOptions - The request options to use for the find one
+   */
+  async findOne(prompt, config, requestOptions = {}) {
+    const augmentedConfig = {
+      ...config,
+      nodeHandleId: this.nodeHandleId
+    };
+    return this.windowClient.findOne(prompt, augmentedConfig, requestOptions);
+  }
+};
 
 // src/window/AirtopWindowScreenshot.ts
 function extractMimeAndBase64(dataUrl) {
@@ -385,7 +485,7 @@ var AirtopWindowClient = class extends AirtopBase {
         sessionId: this.sessionId
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -417,7 +517,7 @@ var AirtopWindowClient = class extends AirtopBase {
         ...config || {}
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -441,7 +541,7 @@ var AirtopWindowClient = class extends AirtopBase {
         ...config
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -463,7 +563,7 @@ var AirtopWindowClient = class extends AirtopBase {
         ...config || {}
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -491,7 +591,7 @@ var AirtopWindowClient = class extends AirtopBase {
         ...newConfig || {}
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -519,7 +619,7 @@ var AirtopWindowClient = class extends AirtopBase {
         ...newConfig || {}
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -539,7 +639,7 @@ var AirtopWindowClient = class extends AirtopBase {
         ...config || {}
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -559,7 +659,7 @@ var AirtopWindowClient = class extends AirtopBase {
         ...config || {}
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -580,7 +680,7 @@ var AirtopWindowClient = class extends AirtopBase {
         ...config || {}
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
@@ -604,11 +704,109 @@ var AirtopWindowClient = class extends AirtopBase {
         ...config || {}
       },
       {
-        timeout: secondsToMilliseconds2(600),
+        timeout: secondsToMilliseconds3(600),
         ...this.resolveRequestOptions(requestOptions)
       }
     );
   }
+  async extract(prompt, config, requestOptions = {}) {
+    this.log.withMetadata({ prompt }).info("Extracting content");
+    return withRequestCompletionPolling(
+      this.client,
+      () => this.client.windows.extract(
+        this.getWindowId(),
+        {
+          prompt,
+          sessionId: this.sessionId,
+          jobId: this.jobId,
+          ...config || {}
+        },
+        {
+          timeout: secondsToMilliseconds3(600),
+          ...this.resolveRequestOptions(requestOptions)
+        }
+      )
+    );
+  }
+  async act(prompt, config, requestOptions = {}) {
+    this.log.withMetadata({ prompt }).info("Acting on content");
+    return withRequestCompletionPolling(
+      this.client,
+      () => this.client.windows.act(
+        this.getWindowId(),
+        {
+          prompt,
+          sessionId: this.sessionId,
+          jobId: this.jobId,
+          ...config || {}
+        },
+        {
+          timeout: secondsToMilliseconds3(600),
+          ...this.resolveRequestOptions(requestOptions)
+        }
+      )
+    );
+  }
+  async llm(prompt, config, requestOptions = {}) {
+    this.log.withMetadata({ prompt }).info("Executing LLM call");
+    return withRequestCompletionPolling(
+      this.client,
+      () => this.client.windows.llm(
+        this.getWindowId(),
+        {
+          prompt,
+          sessionId: this.sessionId,
+          ...config || {}
+        },
+        {
+          timeout: secondsToMilliseconds3(600),
+          ...this.resolveRequestOptions(requestOptions)
+        }
+      )
+    );
+  }
+  async findOne(prompt, config, requestOptions = {}) {
+    this.log.withMetadata({ prompt }).info("Executing LLM call");
+    const apiResponse = await withRequestCompletionPolling(
+      this.client,
+      () => this.client.windows.findOne(
+        this.getWindowId(),
+        {
+          prompt,
+          sessionId: this.sessionId,
+          jobId: this.jobId,
+          ...config || {}
+        },
+        {
+          timeout: secondsToMilliseconds3(600),
+          ...this.resolveRequestOptions(requestOptions)
+        }
+      )
+    );
+    const nodeHandleId = apiResponse.data.modelResponse;
+    return new AirtopNodeImpl(this, nodeHandleId);
+  }
+  async findMany(prompt, config, requestOptions = {}) {
+    this.log.withMetadata({ prompt }).info("Executing LLM call");
+    const apiResponse = await withRequestCompletionPolling(
+      this.client,
+      () => this.client.windows.findMany(
+        this.getWindowId(),
+        {
+          prompt,
+          sessionId: this.sessionId,
+          jobId: this.jobId,
+          ...config || {}
+        },
+        {
+          timeout: secondsToMilliseconds3(600),
+          ...this.resolveRequestOptions(requestOptions)
+        }
+      )
+    );
+    const nodeHandleIds = apiResponse.data.modelResponse.split(",");
+    return nodeHandleIds.map((nodeHandleId) => new AirtopNodeImpl(this, nodeHandleId));
+  }
 };
 
 // src/window/AirtopWindow.ts
@@ -868,7 +1066,8 @@ var AirtopClient = class extends AirtopBase {
         contextFieldName: "context",
         metadataFieldName: "metadata"
       }),
-      outputSchemaAdapter: config.outputSchemaAdapter
+      outputSchemaAdapter: config.outputSchemaAdapter,
+      jobId: config.jobId
     });
     this.log.withPrefix("[Airtop SDK]");
     this.client.logLevel = config.logLevel;
@@ -894,8 +1093,8 @@ var AirtopClient = class extends AirtopBase {
    * @returns A new AirtopSession instance
    */
   async createSession(config, options = {}) {
-    const skipWaitSessionReady = config.skipWaitSessionReady ?? false;
-    delete config.skipWaitSessionReady;
+    const skipWaitSessionReady = config?.skipWaitSessionReady ?? false;
+    delete config?.skipWaitSessionReady;
     const sessionResponse = await this.client.sessions.create(
       {
         configuration: config