@airtop/sdk 1.0.0-alpha2.11 → 1.0.0-alpha2.12

package/dist/index.d.ts

@@ -4,14 +4,14 @@ import { AirtopJsonSchemaAdapter } from '@airtop/json-schema-adapter';
 export { AirtopJsonSchemaAdapter } from '@airtop/json-schema-adapter';
 import { ILogLayer } from 'loglayer';
 export { ILogLayer } from 'loglayer';
+import * as _airtop_core_resources_shared_js from '@airtop/core/resources/shared.js';
+import { Issue, SessionConfigV1, GetFileResponse, FilesResponse, ListAutomationsOutput, AutomationData, ExternalSessionWithConnectionInfo, EnvelopeDefaultMeta, 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_shared_mjs from '@airtop/core/resources/shared.mjs';
 import { AutomationUpdateDescriptionParams } from '@airtop/core/resources/automations.js';
 import { SessionListParams, ProfileOutput, FileListParams, FileCreateFileParams, WindowIDData, EnvelopeDefaultMeta as EnvelopeDefaultMeta$1, Issue as Issue$1, WindowInfo, WindowGetParams, AIPromptResponse, ScrapeResponse } from '@airtop/core/resources/index.js';
-import * as _airtop_core_resources_shared_js from '@airtop/core/resources/shared.js';
-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, WindowExtractParams, WindowActParams, WindowLlmParams, WindowFindOneParams, WindowFindManyParams, WindowWaitForPageParams } from '@airtop/core/resources/windows.js';
+import { WindowClickParams, WindowHoverParams, WindowLoadURLParams, WindowMonitorParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowExtractParams, WindowActParams, WindowLlmParams, WindowFindOneParams, WindowFindManyParams, WindowWaitForPageParams, WindowNavigateParams } from '@airtop/core/resources/windows.js';
 
 /**
  * Shared configuration between Airtop classes.
@@ -79,6 +79,14 @@ interface CommonResponse {
     warnings?: unknown;
     errors?: unknown;
 }
+/**
+ * Custom error class that implements the Issue interface.
+ * Extends the native Error class to provide a more structured error handling mechanism.
+ */
+declare class AirtopError extends Error {
+    issues: Issue[];
+    constructor(issues: Issue[]);
+}
 
 /**
  * Base class for Airtop SDK implementation
@@ -482,6 +490,18 @@ interface WindowFindManyConfig extends Omit<WindowFindManyParams, "sessionId" |
  */
 interface WindowWaitForPageConfig extends Omit<WindowWaitForPageParams, "sessionId"> {
 }
+/**
+ * Configuration parameters for navigating browser history in a window.
+ */
+interface WindowNavigateConfig extends Omit<WindowNavigateParams, "sessionId"> {
+}
+/**
+ * The direction to navigate in browser history.
+ */
+declare enum WindowNavigateDirection {
+    BACK = "backward",
+    FORWARD = "forward"
+}
 /**
  * Data object representing a node returned from the Airtop API.
  */
@@ -714,9 +734,14 @@ declare class AirtopWindowClient extends AirtopBase {
     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[]>;
+    private findOnePrivate;
+    findOne(prompt: string, config?: Omit<WindowFindOneConfig, "optional">, requestOptions?: AirtopRequestOptions): Promise<AirtopNode>;
+    findOneOptional(prompt: string, config?: Omit<WindowFindOneConfig, "optional">, requestOptions?: AirtopRequestOptions): Promise<AirtopNode | null>;
+    private findManyPrivate;
+    findMany(prompt: string, config?: Omit<WindowFindManyConfig, "optional">, requestOptions?: AirtopRequestOptions): Promise<AirtopNode[]>;
+    findManyOptional(prompt: string, config?: Omit<WindowFindManyConfig, "optional">, requestOptions?: AirtopRequestOptions): Promise<AirtopNode[]>;
     waitForPage(config?: WindowWaitForPageConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
+    navigate(direction: WindowNavigateDirection, config?: WindowNavigateConfig, requestOptions?: AirtopRequestOptions): Promise<WindowPromptResponse>;
 }
 
 /**
@@ -1157,4 +1182,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, AirtopNode, type AirtopNodeApiResponseData, 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 WindowWaitForPageConfig, type WindowWarning, registerAirtopPlugin };
+export { type AirtopAutomationData, type AirtopAutomationListResponse, type AirtopAutomationUpdateDescriptionConfig, AirtopBase, AirtopClient, type AirtopClientPlugin, type AirtopConstructorConfig, AirtopError, type AirtopFileListParams, type AirtopFileResponse, type AirtopFilesResponse, AirtopMocks, AirtopNode, type AirtopNodeApiResponseData, 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 WindowNavigateConfig, WindowNavigateDirection, type WindowPageQueryConfig, type WindowPaginatedExtractionConfig, type WindowPromptResponse, type WindowScrapeConfig, type WindowScrapeResponse, type WindowScreenshotConfig, type WindowScrollConfig, type WindowTypeConfig, type WindowWaitForPageConfig, 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.11",
+      version: "1.0.0-alpha2.12",
       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.27",
+        "@airtop/core": "0.1.0-alpha.28",
         "date-fns": "4.1.0",
         loglayer: "6.3.3",
         "serialize-error": "12.0.0",
@@ -264,13 +264,23 @@ var processLogMessage = (log, logLevel, ...args) => {
 // src/session/AirtopSessionClient.ts
 import { NotFoundError } from "@airtop/core";
 
+// src/types.ts
+var AirtopError = class extends Error {
+  issues;
+  constructor(issues) {
+    const errorMessage = issues.map((issue) => issue.message).join("\n");
+    super(errorMessage);
+    this.issues = issues;
+  }
+};
+
 // 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;
+var DEFAULT_POLLING_INTERVAL_MS = 500;
 async function waitForRequestCompletion(client, requestId, requestOptions) {
   const startTime = Date.now();
   const timeoutMs = secondsToMilliseconds2(requestOptions?.timeoutInSeconds || DEFAULT_TIMEOUT_SECONDS);
@@ -282,7 +292,7 @@ async function waitForRequestCompletion(client, requestId, requestOptions) {
     if (apiResponse.status === "error") {
       throw new Error(apiResponse.error);
     }
-    await new Promise((resolve) => setTimeout(resolve, secondsToMilliseconds2(DEFAULT_POLLING_INTERVAL_SECONDS)));
+    await new Promise((resolve) => setTimeout(resolve, DEFAULT_POLLING_INTERVAL_MS));
   }
   throw new Error("Waiting for request timed out");
 }
@@ -811,7 +821,7 @@ var AirtopWindowClient = class extends AirtopBase {
       )
     );
   }
-  async findOne(prompt, config, requestOptions = {}) {
+  async findOnePrivate(prompt, config, requestOptions = {}) {
     this.log.withMetadata({ prompt }).info("Executing LLM call");
     const apiResponse = await withRequestCompletionPolling(
       this.client,
@@ -829,15 +839,32 @@ var AirtopWindowClient = class extends AirtopBase {
         }
       )
     );
+    if (apiResponse.errors.length > 0) {
+      throw new AirtopError(apiResponse.errors);
+    }
     try {
+      if (!apiResponse.data.modelResponse) {
+        return null;
+      }
       const nodeData = JSON.parse(apiResponse.data.modelResponse);
+      if (Object.keys(nodeData).length === 0) {
+        return null;
+      }
       return new AirtopNode(this, nodeData);
     } catch (error) {
       this.log.withMetadata({ nodeDataStr: apiResponse.data.modelResponse }).withError(error).error("Error parsing node data");
       throw error;
     }
   }
-  async findMany(prompt, config, requestOptions = {}) {
+  async findOne(prompt, config, requestOptions = {}) {
+    const configOverride = { ...config, optional: false };
+    return await this.findOnePrivate(prompt, configOverride, requestOptions);
+  }
+  async findOneOptional(prompt, config, requestOptions = {}) {
+    const configOverride = { ...config, optional: true };
+    return await this.findOnePrivate(prompt, configOverride, requestOptions);
+  }
+  async findManyPrivate(prompt, config, requestOptions = {}) {
     this.log.withMetadata({ prompt }).info("Executing LLM call");
     const apiResponse = await withRequestCompletionPolling(
       this.client,
@@ -855,15 +882,32 @@ var AirtopWindowClient = class extends AirtopBase {
         }
       )
     );
+    if (apiResponse.errors.length > 0) {
+      throw new AirtopError(apiResponse.errors);
+    }
     const nodeHandles = apiResponse.data.modelResponse.split("___DELIM___");
     return nodeHandles.map((nodeDataStr) => {
       try {
+        if (!nodeDataStr) {
+          return null;
+        }
         const nodeData = JSON.parse(nodeDataStr);
+        if (Object.keys(nodeData).length === 0) {
+          return null;
+        }
         return new AirtopNode(this, nodeData);
       } catch (error) {
         this.log.withMetadata({ nodeDataStr }).withError(error).error("Error parsing node data");
       }
-    });
+    }).filter((node) => !!node);
+  }
+  async findMany(prompt, config, requestOptions = {}) {
+    const configOverride = { ...config, optional: false };
+    return await this.findManyPrivate(prompt, configOverride, requestOptions);
+  }
+  async findManyOptional(prompt, config, requestOptions = {}) {
+    const configOverride = { ...config, optional: true };
+    return await this.findManyPrivate(prompt, configOverride, requestOptions);
   }
   async waitForPage(config, requestOptions = {}) {
     return await withRequestCompletionPolling(
@@ -881,6 +925,23 @@ var AirtopWindowClient = class extends AirtopBase {
       )
     );
   }
+  async navigate(direction, config, requestOptions = {}) {
+    return await withRequestCompletionPolling(
+      this.client,
+      () => this.client.windows.navigate(
+        this.getWindowId(),
+        {
+          direction,
+          sessionId: this.sessionId,
+          ...config || {}
+        },
+        {
+          timeout: secondsToMilliseconds3(600),
+          ...this.resolveRequestOptions(requestOptions)
+        }
+      )
+    );
+  }
 };
 
 // src/window/AirtopWindow.ts
@@ -1317,6 +1378,13 @@ var AirtopClient = class extends AirtopBase {
   }
 };
 
+// src/window/AirtopWindowClient.types.ts
+var WindowNavigateDirection = /* @__PURE__ */ ((WindowNavigateDirection2) => {
+  WindowNavigateDirection2["BACK"] = "backward";
+  WindowNavigateDirection2["FORWARD"] = "forward";
+  return WindowNavigateDirection2;
+})(WindowNavigateDirection || {});
+
 // src/plugin/AirtopPlugin.types.ts
 var AirtopPluginAugmentationType = /* @__PURE__ */ ((AirtopPluginAugmentationType2) => {
   AirtopPluginAugmentationType2["AirtopClient"] = "AirtopClient";
@@ -1447,6 +1515,7 @@ var AirtopMocks = class {
 export {
   AirtopBase,
   AirtopClient,
+  AirtopError,
   AirtopMocks,
   AirtopNode,
   AirtopPluginAugmentationType,
@@ -1455,6 +1524,7 @@ export {
   AirtopWindow,
   AirtopWindowClient,
   AirtopWindowScreenshot,
+  WindowNavigateDirection,
   registerAirtopPlugin
 };
 //# sourceMappingURL=index.js.map