@airtop/sdk 1.0.0-alpha2.25 → 1.0.0-alpha2.27

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.25",
+      version: "1.0.0-alpha2.27",
       type: "module",
       main: "./dist/index.cjs",
       module: "./dist/index.js",
@@ -38,7 +38,8 @@ var require_package = __commonJS({
         "agentic"
       ],
       scripts: {
-        "test:e2e": "vitest --run",
+        "test:e2e": "vitest --run --max-concurrency=1 --no-file-parallelism",
+        "test:e2e:parallel": "vitest --run",
         "build:dev": "node_modules/.bin/hash-runner",
         build: "tsup src/index.ts",
         clean: "rm -rf .turbo node_modules dist",
@@ -47,16 +48,16 @@ var require_package = __commonJS({
         "verify-types": "tsc --noEmit && tsc --noEmit --project tsconfig.e2e.json"
       },
       dependencies: {
-        "@airtop/core": "0.1.0-alpha.41",
+        "@airtop/core": "0.1.0-alpha.42",
         "@airtop/json-schema-adapter": "workspace:*",
         "date-fns": "4.1.0",
-        loglayer: "6.6.0",
+        loglayer: "6.7.0",
         "serialize-error": "12.0.0",
         uuid: "11.1.0"
       },
       devDependencies: {
-        "@biomejs/biome": "2.2.0",
-        "@dotenvx/dotenvx": "1.48.4",
+        "@biomejs/biome": "2.2.4",
+        "@dotenvx/dotenvx": "1.49.1",
         "@internal/tsconfig": "workspace:*",
         "deep-utility-types": "1.3.1",
         "env-var": "7.5.0",
@@ -80,11 +81,16 @@ var require_package = __commonJS({
       optionalDependencies: {
         "@airtop/json-schema-adapter-zod": "workspace:*"
       },
-      packageManager: "pnpm@10.14.0"
+      packageManager: "pnpm@10.17.0"
     };
   }
 });
 
+// src/index.ts
+import * as AirtopCore4 from "@airtop/core/resources/index.js";
+import * as AirtopCoreShared from "@airtop/core/resources/shared.mjs";
+import * as AirtopCoreWindows from "@airtop/core/resources/windows.js";
+
 // src/AirtopBase.ts
 import { secondsToMilliseconds } from "date-fns";
 
@@ -235,6 +241,90 @@ import { secondsToMilliseconds as secondsToMilliseconds3 } from "date-fns/second
 import { ConsoleTransport, LogLayer } from "loglayer";
 import { serializeError } from "serialize-error";
 
+// src/file/AirtopFileClient.ts
+var AirtopFileClient = class extends AirtopBase {
+  /**
+   * The file id
+   * @internal
+   */
+  fileId;
+  /**
+   * Creates a new AirtopFileClient instance.
+   * @param config - Common configuration options
+   * @param fileId - File id
+   */
+  constructor(config, fileId) {
+    super(config);
+    this.log = this.log.child().withContext({
+      fileId
+    });
+    this.fileId = fileId;
+  }
+  /**
+   * Gets a file by ID.
+   * @param requestOptions
+   * @returns AirtopFile instance
+   */
+  async getFile(requestOptions = {}) {
+    const results = await this.client.files.get(this.fileId, this.resolveRequestOptions(requestOptions));
+    return new AirtopFile(this.getCommonConfig(), results);
+  }
+  /**
+   * Removes a file by ID.
+   * @param requestOptions - Request options
+   */
+  async removeFile(requestOptions = {}) {
+    return this.client.files.delete(this.fileId, this.resolveRequestOptions(requestOptions));
+  }
+};
+
+// src/file/AirtopFile.ts
+var AirtopFile = class extends AirtopFileClient {
+  /**
+   * The file data containing details such as the id, file name, type, and download URL.
+   * Includes all information about the file that was processed or retrieved.
+   */
+  data;
+  /**
+   * The metadata associated with the file operation.
+   * Contains information about the request that processed the file.
+   */
+  meta;
+  /**
+   * Warnings that occurred during file processing or operation.
+   * These are non-fatal issues that didn't prevent file processing.
+   */
+  warnings;
+  /**
+   * Errors that occurred during file processing or operation.
+   * These are fatal issues that prevented file processing.
+   */
+  errors;
+  /**
+   * Creates a new AirtopFile instance.
+   * @param config - Common configuration options for the file
+   * @param fileData - File data
+   */
+  constructor(config, fileData) {
+    super(config, fileData.data.id);
+    this.meta = fileData.meta;
+    this.data = fileData.data;
+    this.warnings = fileData.warnings;
+    this.errors = fileData.errors;
+  }
+  /**
+   * Returns response data as a JSON object.
+   */
+  toJSON() {
+    return {
+      data: this.data,
+      meta: this.meta,
+      warnings: this.warnings,
+      errors: this.errors
+    };
+  }
+};
+
 // src/logger-utils.ts
 var processLogMessage = (log, logLevel, ...args) => {
   if (logLevel === "off") {
@@ -1091,7 +1181,7 @@ var AirtopSessionClient = class extends AirtopBase {
    */
   sessionId;
   /**
-   * Creates a new AirtopSession instance.
+   * Creates a new AirtopSessionClient instance.
    * @param config - Common configuration options for the session
    * @param sessionId - Browser session id
    */
@@ -1218,10 +1308,11 @@ var AirtopSessionClient = class extends AirtopBase {
    * @param fileName - The name of the file to create
    * @param config - Additional configuration options for creating the file
    * @param requestOptions - Request options
+   * @returns AirtopFile instance
    */
-  createFile(fileName, config = {}, requestOptions = {}) {
+  async createFile(fileName, config = {}, requestOptions = {}) {
     this.log.info("Creating file");
-    return this.client.files.createFile(
+    const results = await this.client.files.createFile(
       {
         ...config,
         fileName,
@@ -1229,6 +1320,7 @@ var AirtopSessionClient = class extends AirtopBase {
       },
       this.resolveRequestOptions(requestOptions)
     );
+    return new AirtopFile(this.getCommonConfig(), results);
   }
   async llm(prompt, config, requestOptions = {}) {
     this.log.withMetadata({ prompt }).info("Executing LLM call");
@@ -1267,26 +1359,31 @@ var AirtopSessionClient = class extends AirtopBase {
     if (typeof promptOrArgs === "string") {
       const prompt = promptOrArgs;
       const service = typeof serviceOrRequestOptions === "string" ? serviceOrRequestOptions : void 0;
-      const options = typeof serviceOrRequestOptions === "object" ? serviceOrRequestOptions : requestOptions;
+      const options2 = typeof serviceOrRequestOptions === "object" ? serviceOrRequestOptions : requestOptions;
       this.log.withMetadata({ prompt }).info("Service");
-      const parameters = { prompt, services: service };
-      const body = { parameters };
+      const parameters2 = { prompt, services: service };
+      const body2 = { parameters: parameters2 };
       return withRequestCompletionPolling(
         this.client,
-        () => this.client.sessions.service(this.sessionId, body),
-        options
-      );
-    } else {
-      const parameters = promptOrArgs;
-      const options = serviceOrRequestOptions || {};
-      this.log.withMetadata({ parameters }).info("Service");
-      const body = { parameters };
-      return withRequestCompletionPolling(
-        this.client,
-        () => this.client.sessions.service(this.sessionId, body),
-        options
+        () => this.client.sessions.service(this.sessionId, body2),
+        options2
       );
     }
+    const parameters = promptOrArgs;
+    const options = serviceOrRequestOptions || {};
+    this.log.withMetadata({ parameters }).info("Service");
+    const body = {
+      parameters: {
+        prompt: parameters.prompt,
+        services: parameters.services,
+        outputSchema: parameters.outputSchema ? this.convertToJsonSchema(parameters.outputSchema) : void 0
+      }
+    };
+    return withRequestCompletionPolling(
+      this.client,
+      () => this.client.sessions.service(this.sessionId, body),
+      options
+    );
   }
   /**
    * Retrieves the list of connected services available for the current session.
@@ -1300,6 +1397,58 @@ var AirtopSessionClient = class extends AirtopBase {
       requestOptions
     );
   }
+  /**
+   * Waits for a file to be downloaded in a session and reach 'available' status.
+   * Defaults to looking back 5 seconds in the event stream for the file to be available.
+   * Use `lookbackSeconds` to control this behavior.
+   *
+   * @param configuration - The optional configuration parameters for the function
+   * @param configuration.lookbackSeconds - The number of seconds to look back for prior events. Default `5`. 0 means no lookback.
+   * @param requestOptions - Optional request configuration including timeout
+   * @returns Object containing file's id and downloadUrl, or null if timed out
+   */
+  async waitForDownload(configuration, requestOptions = {}) {
+    const { lookbackSeconds = 5 } = configuration || {};
+    this.log.info(`waiting for file to be available on session: ${this.sessionId}`);
+    const startTime = /* @__PURE__ */ new Date();
+    const timeoutSeconds = requestOptions?.timeoutInSeconds || 120;
+    const timeoutPromise = new Promise((resolve) => {
+      setTimeout(() => {
+        this.log.info(`waiting for file timed out after ${timeoutSeconds} seconds`);
+        resolve(null);
+      }, timeoutSeconds * 1e3);
+    });
+    const processEventsPromise = (async () => {
+      const sessionEvents = await this.client.sessions.getEvents(
+        this.sessionId,
+        { all: lookbackSeconds >= 0 },
+        { timeoutInSeconds: timeoutSeconds, ...requestOptions || {} }
+      );
+      for await (const event of sessionEvents) {
+        const e = event;
+        if (e.event === "file_status") {
+          if (e.status === "available") {
+            const eventTime = Date.parse(e.eventTime);
+            this.log.info(`file_status message received:
+${JSON.stringify(event, null, 2)}`);
+            const thresholdTime = startTime.getTime() - lookbackSeconds * 1e3;
+            if (eventTime < thresholdTime) {
+              this.log.info(
+                `skipping file available event for ${e.fileId} because its timestamp is earlier than lookbackSeconds`
+              );
+              continue;
+            }
+            return {
+              id: e.fileId,
+              downloadUrl: e.downloadUrl
+            };
+          }
+        }
+      }
+      return null;
+    })();
+    return Promise.race([timeoutPromise, processEventsPromise]);
+  }
 };
 
 // src/session/AirtopSession.ts
@@ -1499,6 +1648,13 @@ var AirtopClient = class extends AirtopBase {
   withSessionId(sessionId) {
     return new AirtopSessionClient(this.getCommonConfig(), sessionId);
   }
+  /**
+   * Returns a file client instance for making file-based requests for a given file id.
+   * @param fileId - The file ID to attach to the AirtopFileClient instance
+   */
+  withFileId(fileId) {
+    return new AirtopFileClient(this.getCommonConfig(), fileId);
+  }
   /**
    * Retrieves the status of a request.
    * @param requestId - ID of the request to check
@@ -1511,29 +1667,25 @@ var AirtopClient = class extends AirtopBase {
     }).info("Getting request status");
     return this.client.requests.getRequestStatus(requestId, this.resolveRequestOptions(requestOptions));
   }
-  /**
-   * Gets a file by ID.
-   * @param fileId
-   * @param requestOptions
-   */
-  async getFile(fileId, requestOptions = {}) {
-    return this.client.files.get(fileId, this.resolveRequestOptions(requestOptions));
-  }
-  /**
-   * Removes a file by ID.
-   * @param fileId - ID of the file to remove
-   * @param requestOptions - Request options
-   */
-  async removeFile(fileId, requestOptions = {}) {
-    return this.client.files.delete(fileId, this.resolveRequestOptions(requestOptions));
-  }
   /**
    * List files
-   * @param query
-   * @param requestOptions
+   * @param query - File list parameters
+   * @param requestOptions - Request options
+   * @returns Object containing pagination info and array of AirtopFile instances
    */
   async listFiles(query, requestOptions = {}) {
-    return this.client.files.list(query, this.resolveRequestOptions(requestOptions));
+    const files = await this.client.files.list(query, this.resolveRequestOptions(requestOptions));
+    return {
+      pagination: files.data.pagination,
+      files: files.data.files.map(
+        (file) => new AirtopFile(this.getCommonConfig(), {
+          data: file
+        })
+      ),
+      errors: files.errors,
+      meta: files.meta,
+      warnings: files.warnings
+    };
   }
   /**
    * List all automations
@@ -1905,7 +2057,12 @@ export {
   AirtopAgentClient,
   AirtopBase,
   AirtopClient,
+  AirtopCore4 as AirtopCore,
+  AirtopCoreShared,
+  AirtopCoreWindows,
   AirtopError,
+  AirtopFile,
+  AirtopFileClient,
   AirtopMocks,
   AirtopNode,
   AirtopPluginAugmentationType,