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

package/dist/index.cjs

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; } function _optionalChainDelete(ops) { const result = _optionalChain(ops); return result == null ? true : result; }var __getOwnPropNames = Object.getOwnPropertyNames;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; } function _optionalChainDelete(ops) { const result = _optionalChain(ops); return result == null ? true : result; }var __getOwnPropNames = Object.getOwnPropertyNames;
 var __commonJS = (cb, mod) => function __require() {
   return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
 };
@@ -9,7 +9,7 @@ var require_package = __commonJS({
     module.exports = {
       name: "@airtop/sdk",
       description: "Airtop SDK for TypeScript",
-      version: "1.0.0-alpha2.26",
+      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",
@@ -85,6 +86,11 @@ var require_package = __commonJS({
   }
 });
 
+// src/index.ts
+var _indexjs = require('@airtop/core/resources/index.js'); var AirtopCore4 = _interopRequireWildcard(_indexjs);
+var _sharedmjs = require('@airtop/core/resources/shared.mjs'); var AirtopCoreShared = _interopRequireWildcard(_sharedmjs);
+var _windowsjs = require('@airtop/core/resources/windows.js'); var AirtopCoreWindows = _interopRequireWildcard(_windowsjs);
+
 // src/AirtopBase.ts
 var _datefns = require('date-fns');
 
@@ -235,6 +241,90 @@ var _secondsToMilliseconds = require('date-fns/secondsToMilliseconds');
 var _loglayer = require('loglayer');
 var _serializeerror = require('serialize-error');
 
+// src/file/AirtopFileClient.ts
+var AirtopFileClient = class extends AirtopBase {
+  /**
+   * The file id
+   * @internal
+   */
+  
+  /**
+   * 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.
+   */
+  
+  /**
+   * The metadata associated with the file operation.
+   * Contains information about the request that processed the file.
+   */
+  
+  /**
+   * Warnings that occurred during file processing or operation.
+   * These are non-fatal issues that didn't prevent file processing.
+   */
+  
+  /**
+   * Errors that occurred during file processing or operation.
+   * These are fatal issues that prevented file processing.
+   */
+  
+  /**
+   * 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 {
    */
   
   /**
-   * 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,32 +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 };
-      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: {
-          prompt: parameters.prompt,
-          services: parameters.services,
-          outputSchema: parameters.outputSchema ? this.convertToJsonSchema(parameters.outputSchema) : void 0
-        }
-      };
+      const parameters2 = { prompt, services: service };
+      const body2 = { parameters: parameters2 };
       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.
@@ -1306,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 = _optionalChain([requestOptions, 'optionalAccess', _19 => _19.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
@@ -1364,19 +1507,19 @@ var AirtopClient = class extends AirtopBase {
    */
   constructor(config) {
     super({
-      logLevel: _optionalChain([config, 'optionalAccess', _19 => _19.logLevel]),
+      logLevel: _optionalChain([config, 'optionalAccess', _20 => _20.logLevel]),
       client: new (0, _core.Airtop)({
         maxRetries: 0,
         timeout: _secondsToMilliseconds.secondsToMilliseconds.call(void 0, _nullishCoalesce(config.defaultTimeoutInSeconds, () => ( TIMEOUT_SECONDS_DEFAULT_VALUE))),
         apiKey: config.apiKey,
-        baseURL: _optionalChain([config, 'optionalAccess', _20 => _20.airtopUrl]),
-        logLevel: _optionalChain([config, 'optionalAccess', _21 => _21.logLevel]) || "off",
+        baseURL: _optionalChain([config, 'optionalAccess', _21 => _21.airtopUrl]),
+        logLevel: _optionalChain([config, 'optionalAccess', _22 => _22.logLevel]) || "off",
         defaultHeaders: {
           "x-airtop-sdk-source": "typescript",
           "x-airtop-sdk-version": version
         }
       }),
-      log: _optionalChain([config, 'optionalAccess', _22 => _22.logger]) || new (0, _loglayer.LogLayer)({
+      log: _optionalChain([config, 'optionalAccess', _23 => _23.logger]) || new (0, _loglayer.LogLayer)({
         errorSerializer: _serializeerror.serializeError,
         transport: new (0, _loglayer.ConsoleTransport)({
           logger: console,
@@ -1416,8 +1559,8 @@ var AirtopClient = class extends AirtopBase {
    * @returns A new AirtopSession instance
    */
   async createSession(config, options = {}) {
-    const skipWaitSessionReady = _nullishCoalesce(_optionalChain([config, 'optionalAccess', _23 => _23.skipWaitSessionReady]), () => ( false));
-     _optionalChainDelete([config, 'optionalAccess', _24 => delete _24.skipWaitSessionReady]);
+    const skipWaitSessionReady = _nullishCoalesce(_optionalChain([config, 'optionalAccess', _24 => _24.skipWaitSessionReady]), () => ( false));
+     _optionalChainDelete([config, 'optionalAccess', _25 => delete _25.skipWaitSessionReady]);
     const sessionResponse = await this.client.sessions.create(
       {
         configuration: config
@@ -1505,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
@@ -1517,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
@@ -1670,19 +1816,19 @@ var AirtopAgentClient = class extends AirtopBase {
    */
   constructor(config) {
     super({
-      logLevel: _optionalChain([config, 'optionalAccess', _25 => _25.logLevel]),
+      logLevel: _optionalChain([config, 'optionalAccess', _26 => _26.logLevel]),
       client: new (0, _core.Airtop)({
         maxRetries: 0,
         timeout: _datefns.minutesToMilliseconds.call(void 0, 1),
         apiKey: config.apiKey,
-        baseURL: _optionalChain([config, 'optionalAccess', _26 => _26.airtopUrl]),
-        logLevel: _optionalChain([config, 'optionalAccess', _27 => _27.logLevel]) || "off",
+        baseURL: _optionalChain([config, 'optionalAccess', _27 => _27.airtopUrl]),
+        logLevel: _optionalChain([config, 'optionalAccess', _28 => _28.logLevel]) || "off",
         defaultHeaders: {
           "x-airtop-sdk-source": "typescript",
           "x-airtop-sdk-version": _process.version
         }
       }),
-      log: _optionalChain([config, 'optionalAccess', _28 => _28.logger]) || new (0, _loglayer.LogLayer)({
+      log: _optionalChain([config, 'optionalAccess', _29 => _29.logger]) || new (0, _loglayer.LogLayer)({
         errorSerializer: _serializeerror.serializeError,
         transport: new (0, _loglayer.ConsoleTransport)({
           logger: console,
@@ -1922,5 +2068,10 @@ function registerAirtopPlugin(plugin) {
 
 
 
-exports.AirtopAgentClient = AirtopAgentClient; exports.AirtopBase = AirtopBase; exports.AirtopClient = AirtopClient; exports.AirtopError = AirtopError; exports.AirtopMocks = AirtopMocks; exports.AirtopNode = AirtopNode; exports.AirtopPluginAugmentationType = AirtopPluginAugmentationType; exports.AirtopSession = AirtopSession; exports.AirtopSessionClient = AirtopSessionClient; exports.AirtopWindow = AirtopWindow; exports.AirtopWindowClient = AirtopWindowClient; exports.AirtopWindowScreenshot = AirtopWindowScreenshot; exports.WindowNavigateDirection = WindowNavigateDirection; exports.registerAirtopPlugin = registerAirtopPlugin;
+
+
+
+
+
+exports.AirtopAgentClient = AirtopAgentClient; exports.AirtopBase = AirtopBase; exports.AirtopClient = AirtopClient; exports.AirtopCore = AirtopCore4; exports.AirtopCoreShared = AirtopCoreShared; exports.AirtopCoreWindows = AirtopCoreWindows; exports.AirtopError = AirtopError; exports.AirtopFile = AirtopFile; exports.AirtopFileClient = AirtopFileClient; exports.AirtopMocks = AirtopMocks; exports.AirtopNode = AirtopNode; exports.AirtopPluginAugmentationType = AirtopPluginAugmentationType; exports.AirtopSession = AirtopSession; exports.AirtopSessionClient = AirtopSessionClient; exports.AirtopWindow = AirtopWindow; exports.AirtopWindowClient = AirtopWindowClient; exports.AirtopWindowScreenshot = AirtopWindowScreenshot; exports.WindowNavigateDirection = WindowNavigateDirection; exports.registerAirtopPlugin = registerAirtopPlugin;
 //# sourceMappingURL=index.cjs.map