instavm 0.2.2 → 0.3.0

package/README.md

@@ -75,6 +75,29 @@ const execution = await client.execute('python /remote/path/script.py', {
 console.log(execution.output);
 ```
 
+### File Download
+
+```typescript
+import { InstaVM } from 'instavm';
+import fs from 'fs';
+
+const client = new InstaVM('your_api_key');
+
+// Create a file in the remote environment
+await client.execute(`
+import pandas as pd
+df = pd.DataFrame({'name': ['Alice', 'Bob'], 'age': [25, 30]})
+df.to_csv('data.csv', index=False)
+`);
+
+// Download the file
+const result = await client.download('data.csv');
+console.log(`Downloaded ${result.size} bytes`);
+
+// Save to local file
+fs.writeFileSync('local-data.csv', result.content);
+```
+
 ### Error Handling
 
 ```typescript
@@ -432,6 +455,39 @@ console.log('Articles:', articles);
 console.log('Form fields:', formData);
 ```
 
+### LLM-Friendly Content Extraction
+
+```typescript
+// Extract clean, LLM-optimized content from a webpage
+const content = await session.extractContent({
+    includeInteractive: true,  // Include clickable/typeable elements
+    includeAnchors: true,       // Include content-to-selector mappings
+    maxAnchors: 50              // Limit number of anchors
+});
+
+// Get clean article text (no ads, no navigation, no scripts)
+console.log('Title:', content.readableContent.title);
+console.log('Article:', content.readableContent.content);
+console.log('Author:', content.readableContent.byline);
+
+// Find interactive elements (buttons, links, inputs)
+const loginButton = content.interactiveElements?.find(
+    el => el.text?.toLowerCase().includes('login')
+);
+if (loginButton) {
+    await session.click(loginButton.selector);
+}
+
+// Use content anchors to map text to selectors
+// Perfect for LLM agents that need to "read then click"
+const signupLink = content.contentAnchors?.find(
+    anchor => anchor.text.toLowerCase().includes('sign up')
+);
+if (signupLink) {
+    await session.click(signupLink.selector);
+}
+```
+
 ## Error Handling Reference
 
 ### Error Types
@@ -495,7 +551,8 @@ class InstaVM {
     
     // File operations
     upload(files: FileUpload[], options?: UploadOptions): Promise<UploadResult>
-    
+    download(filename: string, options?: DownloadOptions): Promise<DownloadResult>
+
     // Session management
     createSession(): Promise<string>
     closeSession(sessionId?: string): Promise<void>
@@ -565,7 +622,8 @@ class BrowserSession extends EventEmitter {
     // Data extraction
     screenshot(options?: ScreenshotOptions): Promise<string>
     extractElements(selector: string, attributes?: string[]): Promise<ExtractedElement[]>
-    
+    extractContent(options?: ExtractContentOptions): Promise<ExtractedContent>
+
     // Utilities
     wait(condition: WaitCondition, timeout?: number): Promise<void>
     close(): Promise<void>
@@ -750,11 +808,14 @@ main().catch(console.error);
 # Install dependencies
 npm install
 
-# Run unit tests
-npm test
+# Run unit tests (no API key required)
+npm run test:unit
 
 # Run integration tests (requires API key)
-INSTAVM_API_KEY=your_key npm run test:integration
+INSTAVM_API_KEY=your_api_key npm run test:integration
+
+# Run all tests
+npm test
 
 # Build the package
 npm run build
@@ -763,6 +824,8 @@ npm run build
 npm run type-check
 ```
 
+**Note:** Integration tests require a valid InstaVM API key. Set the `INSTAVM_API_KEY` environment variable before running integration tests. Unit tests do not require an API key.
+
 ### Contributing
 
 This is an official SDK. For issues and feature requests, please use the GitHub repository.
@@ -782,6 +845,22 @@ All rights reserved. No redistribution or modification permitted.
 
 ## Changelog
 
+### Version 0.3.0
+
+- ✅ **NEW**: File download functionality - Download files from remote VM
+- ✅ **NEW**: LLM-friendly content extraction - Extract clean, readable content with interactive element mapping
+- ✅ Enhanced browser automation with content anchors for intelligent LLM agents
+- ✅ Full API parity with Python SDK
+
+### Version 0.2.1
+
+- ✅ Bug fixes and improvements
+
+### Version 0.2.0
+
+- ✅ Enhanced session management
+- ✅ Improved error handling
+
 ### Version 0.1.0
 
 - ✅ Code execution fully functional (Python, Bash)

package/dist/index.d.mts

@@ -46,7 +46,7 @@ declare class HTTPClient {
      */
     post<T = any>(url: string, data?: any, headers?: Record<string, string>): Promise<T>;
     /**
-     * POST request for code execution (X-API-Key header is automatically added)
+     * POST request for code execution (uses X-API-Key header like Python client)
      */
     postExecution<T = any>(url: string, data: any, headers?: Record<string, string>): Promise<T>;
     /**
@@ -61,6 +61,10 @@ declare class HTTPClient {
      * DELETE request
      */
     delete<T = any>(url: string, headers?: Record<string, string>): Promise<T>;
+    /**
+     * POST request that returns raw binary data (for file downloads)
+     */
+    postRaw(url: string, data?: any, headers?: Record<string, string>): Promise<ArrayBuffer>;
 }
 
 interface BrowserSessionOptions {
@@ -146,6 +150,34 @@ interface ExtractOptions {
     attributes?: string[];
     maxResults?: number;
 }
+interface ExtractContentOptions {
+    includeInteractive?: boolean;
+    includeAnchors?: boolean;
+    maxAnchors?: number;
+}
+interface InteractiveElement {
+    type: 'button' | 'link' | 'input' | 'select' | 'textarea';
+    selector: string;
+    text?: string;
+    label?: string;
+    placeholder?: string;
+    value?: string;
+}
+interface ContentAnchor {
+    text: string;
+    selector: string;
+}
+interface ExtractedContent {
+    readableContent: {
+        content: string;
+        title?: string;
+        byline?: string;
+        excerpt?: string;
+        siteName?: string;
+    };
+    interactiveElements?: InteractiveElement[];
+    contentAnchors?: ContentAnchor[];
+}
 
 /**
  * Browser session for automation
@@ -183,6 +215,32 @@ declare class BrowserSession extends EventEmitter {
      * Extract elements from the page
      */
     extractElements(selector: string, attributes?: string[], options?: ExtractOptions): Promise<ExtractedElement[]>;
+    /**
+     * Extract LLM-friendly content from the current page
+     *
+     * Returns clean article content, interactive elements, and content anchors
+     * for intelligent browser automation with LLMs.
+     *
+     * @param options - Content extraction options
+     * @returns Extracted content with readable text, interactive elements, and content anchors
+     *
+     * @example
+     * ```typescript
+     * const content = await session.extractContent();
+     *
+     * // LLM reads clean content
+     * const article = content.readableContent.content;
+     *
+     * // LLM finds "Sign Up" in content and uses anchors to get selector
+     * const signUpAnchor = content.contentAnchors?.find(
+     *   anchor => anchor.text.toLowerCase().includes('sign up')
+     * );
+     * if (signUpAnchor) {
+     *   await session.click(signUpAnchor.selector);
+     * }
+     * ```
+     */
+    extractContent(options?: ExtractContentOptions): Promise<ExtractedContent>;
     /**
      * Wait for a condition
      */
@@ -280,6 +338,15 @@ interface UsageStats {
     quotaRemaining: number;
     quotaLimit: number;
 }
+interface DownloadOptions {
+    sessionId?: string;
+}
+interface DownloadResult {
+    success: boolean;
+    filename: string;
+    content: Buffer;
+    size: number;
+}
 
 interface InstaVMOptions {
     baseURL?: string;
@@ -319,6 +386,10 @@ declare class InstaVM {
      * Get usage statistics for a session
      */
     getUsage(sessionId?: string): Promise<UsageStats>;
+    /**
+     * Download a file from the remote VM
+     */
+    download(filename: string, options?: DownloadOptions): Promise<DownloadResult>;
     /**
      * Get the current session ID
      */
@@ -421,4 +492,4 @@ declare class ElementNotFoundError extends BrowserError {
     constructor(message?: string, selector?: string, options?: any);
 }
 
-export { type ApiResponse, type AsyncExecutionResult, AuthenticationError, BrowserError, BrowserInteractionError, BrowserManager, BrowserNavigationError, BrowserSession, BrowserSessionError, type BrowserSessionInfo, type BrowserSessionOptions, BrowserTimeoutError, type ClickOptions, ElementNotFoundError, type ExecuteOptions, ExecutionError, type ExecutionResult, type ExtractOptions, type ExtractedElement, type FileUpload, type FillOptions, type HttpClientConfig, InstaVM, InstaVMError, type InstaVMOptions, type NavigateOptions, type NavigationResult, NetworkError, QuotaExceededError, RateLimitError, type RequestConfig, type RetryConfig, type ScreenshotOptions, type ScrollOptions, SessionError, type TypeOptions, type UploadOptions, type UploadResult, type UsageStats, type WaitCondition };
+export { type ApiResponse, type AsyncExecutionResult, AuthenticationError, BrowserError, BrowserInteractionError, BrowserManager, BrowserNavigationError, BrowserSession, BrowserSessionError, type BrowserSessionInfo, type BrowserSessionOptions, BrowserTimeoutError, type ClickOptions, type ContentAnchor, type DownloadOptions, type DownloadResult, ElementNotFoundError, type ExecuteOptions, ExecutionError, type ExecutionResult, type ExtractContentOptions, type ExtractOptions, type ExtractedContent, type ExtractedElement, type FileUpload, type FillOptions, type HttpClientConfig, InstaVM, InstaVMError, type InstaVMOptions, type InteractiveElement, type NavigateOptions, type NavigationResult, NetworkError, QuotaExceededError, RateLimitError, type RequestConfig, type RetryConfig, type ScreenshotOptions, type ScrollOptions, SessionError, type TypeOptions, type UploadOptions, type UploadResult, type UsageStats, type WaitCondition };

package/dist/index.d.ts

@@ -46,7 +46,7 @@ declare class HTTPClient {
      */
     post<T = any>(url: string, data?: any, headers?: Record<string, string>): Promise<T>;
     /**
-     * POST request for code execution (X-API-Key header is automatically added)
+     * POST request for code execution (uses X-API-Key header like Python client)
      */
     postExecution<T = any>(url: string, data: any, headers?: Record<string, string>): Promise<T>;
     /**
@@ -61,6 +61,10 @@ declare class HTTPClient {
      * DELETE request
      */
     delete<T = any>(url: string, headers?: Record<string, string>): Promise<T>;
+    /**
+     * POST request that returns raw binary data (for file downloads)
+     */
+    postRaw(url: string, data?: any, headers?: Record<string, string>): Promise<ArrayBuffer>;
 }
 
 interface BrowserSessionOptions {
@@ -146,6 +150,34 @@ interface ExtractOptions {
     attributes?: string[];
     maxResults?: number;
 }
+interface ExtractContentOptions {
+    includeInteractive?: boolean;
+    includeAnchors?: boolean;
+    maxAnchors?: number;
+}
+interface InteractiveElement {
+    type: 'button' | 'link' | 'input' | 'select' | 'textarea';
+    selector: string;
+    text?: string;
+    label?: string;
+    placeholder?: string;
+    value?: string;
+}
+interface ContentAnchor {
+    text: string;
+    selector: string;
+}
+interface ExtractedContent {
+    readableContent: {
+        content: string;
+        title?: string;
+        byline?: string;
+        excerpt?: string;
+        siteName?: string;
+    };
+    interactiveElements?: InteractiveElement[];
+    contentAnchors?: ContentAnchor[];
+}
 
 /**
  * Browser session for automation
@@ -183,6 +215,32 @@ declare class BrowserSession extends EventEmitter {
      * Extract elements from the page
      */
     extractElements(selector: string, attributes?: string[], options?: ExtractOptions): Promise<ExtractedElement[]>;
+    /**
+     * Extract LLM-friendly content from the current page
+     *
+     * Returns clean article content, interactive elements, and content anchors
+     * for intelligent browser automation with LLMs.
+     *
+     * @param options - Content extraction options
+     * @returns Extracted content with readable text, interactive elements, and content anchors
+     *
+     * @example
+     * ```typescript
+     * const content = await session.extractContent();
+     *
+     * // LLM reads clean content
+     * const article = content.readableContent.content;
+     *
+     * // LLM finds "Sign Up" in content and uses anchors to get selector
+     * const signUpAnchor = content.contentAnchors?.find(
+     *   anchor => anchor.text.toLowerCase().includes('sign up')
+     * );
+     * if (signUpAnchor) {
+     *   await session.click(signUpAnchor.selector);
+     * }
+     * ```
+     */
+    extractContent(options?: ExtractContentOptions): Promise<ExtractedContent>;
     /**
      * Wait for a condition
      */
@@ -280,6 +338,15 @@ interface UsageStats {
     quotaRemaining: number;
     quotaLimit: number;
 }
+interface DownloadOptions {
+    sessionId?: string;
+}
+interface DownloadResult {
+    success: boolean;
+    filename: string;
+    content: Buffer;
+    size: number;
+}
 
 interface InstaVMOptions {
     baseURL?: string;
@@ -319,6 +386,10 @@ declare class InstaVM {
      * Get usage statistics for a session
      */
     getUsage(sessionId?: string): Promise<UsageStats>;
+    /**
+     * Download a file from the remote VM
+     */
+    download(filename: string, options?: DownloadOptions): Promise<DownloadResult>;
     /**
      * Get the current session ID
      */
@@ -421,4 +492,4 @@ declare class ElementNotFoundError extends BrowserError {
     constructor(message?: string, selector?: string, options?: any);
 }
 
-export { type ApiResponse, type AsyncExecutionResult, AuthenticationError, BrowserError, BrowserInteractionError, BrowserManager, BrowserNavigationError, BrowserSession, BrowserSessionError, type BrowserSessionInfo, type BrowserSessionOptions, BrowserTimeoutError, type ClickOptions, ElementNotFoundError, type ExecuteOptions, ExecutionError, type ExecutionResult, type ExtractOptions, type ExtractedElement, type FileUpload, type FillOptions, type HttpClientConfig, InstaVM, InstaVMError, type InstaVMOptions, type NavigateOptions, type NavigationResult, NetworkError, QuotaExceededError, RateLimitError, type RequestConfig, type RetryConfig, type ScreenshotOptions, type ScrollOptions, SessionError, type TypeOptions, type UploadOptions, type UploadResult, type UsageStats, type WaitCondition };
+export { type ApiResponse, type AsyncExecutionResult, AuthenticationError, BrowserError, BrowserInteractionError, BrowserManager, BrowserNavigationError, BrowserSession, BrowserSessionError, type BrowserSessionInfo, type BrowserSessionOptions, BrowserTimeoutError, type ClickOptions, type ContentAnchor, type DownloadOptions, type DownloadResult, ElementNotFoundError, type ExecuteOptions, ExecutionError, type ExecutionResult, type ExtractContentOptions, type ExtractOptions, type ExtractedContent, type ExtractedElement, type FileUpload, type FillOptions, type HttpClientConfig, InstaVM, InstaVMError, type InstaVMOptions, type InteractiveElement, type NavigateOptions, type NavigationResult, NetworkError, QuotaExceededError, RateLimitError, type RequestConfig, type RetryConfig, type ScreenshotOptions, type ScrollOptions, SessionError, type TypeOptions, type UploadOptions, type UploadResult, type UsageStats, type WaitCondition };

package/dist/index.js

@@ -6,9 +6,6 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __commonJS = (cb, mod) => function __require() {
-  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
-};
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -31,92 +28,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// package.json
-var require_package = __commonJS({
-  "package.json"(exports2, module2) {
-    module2.exports = {
-      name: "instavm",
-      version: "0.2.2",
-      description: "Official JavaScript SDK for InstaVM API",
-      main: "dist/index.js",
-      module: "dist/index.mjs",
-      types: "dist/index.d.ts",
-      exports: {
-        ".": {
-          types: "./dist/index.d.ts",
-          import: "./dist/index.mjs",
-          require: "./dist/index.js"
-        },
-        "./integrations/openai": {
-          types: "./dist/integrations/openai.d.ts",
-          import: "./dist/integrations/openai.mjs",
-          require: "./dist/integrations/openai.js"
-        }
-      },
-      files: [
-        "dist"
-      ],
-      scripts: {
-        dev: "tsup --watch",
-        build: "tsup",
-        "type-check": "tsc --noEmit",
-        test: "vitest",
-        "test:unit": "vitest run tests/unit",
-        "test:integration": "vitest run tests/integration",
-        "test:watch": "vitest --watch",
-        "test:coverage": "vitest --coverage",
-        lint: "eslint src --ext .ts,.tsx",
-        "lint:fix": "eslint src --ext .ts,.tsx --fix",
-        format: "prettier --write src/**/*.ts",
-        prepublishOnly: "npm run build && npm run test:unit",
-        clean: "rm -rf dist"
-      },
-      keywords: [
-        "instavm",
-        "api",
-        "sdk",
-        "browser-automation",
-        "code-execution",
-        "microvm",
-        "cloud"
-      ],
-      author: "InstaVM",
-      license: "UNLICENSED",
-      repository: {
-        type: "git",
-        url: "https://github.com/instavm/js.git"
-      },
-      bugs: {
-        url: "https://github.com/instavm/js/issues"
-      },
-      homepage: "https://github.com/instavm/js#readme",
-      engines: {
-        node: ">=16.0.0"
-      },
-      dependencies: {
-        axios: "^1.7.9",
-        eventemitter3: "^5.0.1",
-        "form-data": "^4.0.1",
-        ws: "^8.18.0"
-      },
-      devDependencies: {
-        "@types/node": "^22.10.5",
-        "@types/ws": "^8.5.13",
-        "@typescript-eslint/eslint-plugin": "^8.18.2",
-        "@typescript-eslint/parser": "^8.18.2",
-        "@vitest/coverage-v8": "^2.1.8",
-        eslint: "^9.18.0",
-        "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-prettier": "^5.2.1",
-        prettier: "^3.4.2",
-        tsup: "^8.3.5",
-        typescript: "^5.7.2",
-        vitest: "^2.1.8"
-      }
-    };
-  }
-});
-
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
@@ -262,14 +173,6 @@ async function withRetry(fn, options) {
 }
 
 // src/client/HTTPClient.ts
-function getPackageVersion() {
-  try {
-    const packageJson = require_package();
-    return packageJson.version || "0.1.0";
-  } catch {
-    return "0.1.0";
-  }
-}
 var HTTPClient = class {
   get apiKey() {
     return this.config.apiKey;
@@ -281,7 +184,7 @@ var HTTPClient = class {
       timeout: config.timeout,
       headers: {
         "Content-Type": "application/json",
-        "User-Agent": `instavm-js-sdk/${getPackageVersion()}`
+        "User-Agent": "instavm-js-sdk/0.1.0"
       }
     });
     this.setupInterceptors();
@@ -289,7 +192,7 @@ var HTTPClient = class {
   setupInterceptors() {
     this.client.interceptors.request.use(
       (config) => {
-        if (!config.headers["X-API-Key"] && !config.url?.includes("/v1/sessions/session")) {
+        if (config.url?.includes("/browser/")) {
           config.headers["X-API-Key"] = this.config.apiKey;
         }
         return config;
@@ -378,14 +281,18 @@ var HTTPClient = class {
     });
   }
   /**
-   * POST request for code execution (X-API-Key header is automatically added)
+   * POST request for code execution (uses X-API-Key header like Python client)
    */
   async postExecution(url, data, headers) {
+    const requestHeaders = {
+      "X-API-Key": this.config.apiKey,
+      ...headers
+    };
     return this.request({
       method: "POST",
       url,
       data,
-      headers
+      headers: requestHeaders
     });
   }
   /**
@@ -424,6 +331,31 @@ var HTTPClient = class {
       headers
     });
   }
+  /**
+   * POST request that returns raw binary data (for file downloads)
+   */
+  async postRaw(url, data, headers) {
+    const requestHeaders = {
+      "X-API-Key": this.config.apiKey,
+      ...headers
+    };
+    const axiosConfig = {
+      method: "POST",
+      url,
+      data,
+      headers: requestHeaders,
+      responseType: "arraybuffer",
+      timeout: this.config.timeout
+    };
+    const makeRequest = async () => {
+      const response = await this.client.request(axiosConfig);
+      return response.data;
+    };
+    return withRetry(makeRequest, {
+      retries: this.config.maxRetries,
+      retryDelay: this.config.retryDelay
+    });
+  }
 };
 
 // src/client/BrowserSession.ts
@@ -650,6 +582,59 @@ var BrowserSession = class extends import_eventemitter3.EventEmitter {
       );
     }
   }
+  /**
+   * Extract LLM-friendly content from the current page
+   *
+   * Returns clean article content, interactive elements, and content anchors
+   * for intelligent browser automation with LLMs.
+   *
+   * @param options - Content extraction options
+   * @returns Extracted content with readable text, interactive elements, and content anchors
+   *
+   * @example
+   * ```typescript
+   * const content = await session.extractContent();
+   *
+   * // LLM reads clean content
+   * const article = content.readableContent.content;
+   *
+   * // LLM finds "Sign Up" in content and uses anchors to get selector
+   * const signUpAnchor = content.contentAnchors?.find(
+   *   anchor => anchor.text.toLowerCase().includes('sign up')
+   * );
+   * if (signUpAnchor) {
+   *   await session.click(signUpAnchor.selector);
+   * }
+   * ```
+   */
+  async extractContent(options = {}) {
+    this.ensureActive();
+    const requestData = {
+      session_id: this.sessionId,
+      include_interactive: options.includeInteractive !== false,
+      include_anchors: options.includeAnchors !== false,
+      max_anchors: options.maxAnchors ?? 50
+    };
+    try {
+      const response = await this.httpClient.post(
+        "/v1/browser/interactions/content",
+        requestData
+      );
+      return {
+        readableContent: {
+          ...response.readable_content || {},
+          content: response.readable_content?.content || ""
+        },
+        interactiveElements: response.interactive_elements,
+        contentAnchors: response.content_anchors
+      };
+    } catch (error) {
+      throw new BrowserInteractionError(
+        `Content extraction failed: ${getErrorMessage(error)}`,
+        { cause: error }
+      );
+    }
+  }
   /**
    * Wait for a condition
    */
@@ -1041,6 +1026,34 @@ var InstaVM = class {
       );
     }
   }
+  /**
+   * Download a file from the remote VM
+   */
+  async download(filename, options = {}) {
+    const targetSessionId = options.sessionId || this._sessionId;
+    if (!targetSessionId) {
+      throw new SessionError("No active session to download from");
+    }
+    try {
+      const response = await this.httpClient.postRaw("/download", {
+        filename,
+        session_id: targetSessionId
+      });
+      const content = Buffer.from(response);
+      return {
+        success: true,
+        filename,
+        content,
+        size: content.length
+      };
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : String(error);
+      throw new SessionError(
+        `File download failed: ${errorMessage}`,
+        { cause: error }
+      );
+    }
+  }
   /**
    * Get the current session ID
    */