Merge pull request #17 from scrapeless-ai/feat/browser_extension

scrapelesshq · web-flow · commit efff7af31310 · 2025-06-25T18:56:40.000-07:00
Feat/browser extension
diff --git a/examples/extension-example.js b/examples/extension-example.js
@@ -0,0 +1,85 @@
+import { Scrapeless } from '@scrapeless-ai/sdk';
+import puppeteer from 'puppeteer-core';
+
+const client = new Scrapeless();
+const { browser: scrapingBrowser } = client;
+
+async function uploadExtension() {
+  const response = await scrapingBrowser.extension.upload('your-file-path.zip', 'Scrapeless');
+  console.log(response);
+}
+
+async function updateExtension(extensionId) {
+  const response = await scrapingBrowser.extension.update(extensionId, 'your-file-path.zip', 'Scrapeless');
+  console.log(response);
+}
+
+async function listExtensions() {
+  const response = await scrapingBrowser.extension.list();
+  console.log(response);
+}
+
+async function deleteExtension(extensionId) {
+  const response = await scrapingBrowser.extension.delete(extensionId);
+  console.log(response);
+}
+
+async function getExtension(extensionId) {
+  const response = await scrapingBrowser.extension.get(extensionId);
+  console.log(response);
+}
+
+async function useExtension(extensionIds) {
+  const { browserWSEndpoint } = scrapingBrowser.create({
+    session_name: 'use-extension',
+    session_ttl: 180,
+    session_recording: true,
+    extension_ids: extensionIds
+  });
+
+  const browser = await puppeteer.connect({
+    browserWSEndpoint,
+    defaultViewport: null
+  });
+
+  const page = await browser.newPage();
+  await page.goto('https://example.com');
+}
+
+async function runExtensionTests() {
+  try {
+    console.log('=== Scrapeless Browser Extension Tests ===\n');
+
+    // Upload a new extension
+    await uploadExtension();
+    console.log('\n');
+
+    // List all extensions
+    await listExtensions();
+    console.log('\n');
+
+    // Get details of a specific extension (replace with actual ID)
+    const extensionId = 'your-extension-id-here'; // Replace with actual extension ID
+    await getExtension(extensionId);
+    console.log('\n');
+
+    // Update the extension (replace with actual ID)
+    await updateExtension(extensionId);
+    console.log('\n');
+
+    // Delete the extension (replace with actual ID)
+    await deleteExtension(extensionId);
+    console.log('\n');
+
+    // Use the extension in a new browser session
+    await useExtension(extensionId);
+    console.log('\n');
+
+    console.log('🎉 All extension tests completed successfully');
+  } catch (error) {
+    console.error('❌ Extension tests failed with error:', error);
+  }
+}
+
+// Run the extension tests
+runExtensionTests().catch(console.error);
diff --git a/src/services/base.ts b/src/services/base.ts
@@ -37,6 +37,14 @@ export abstract class BaseService {
       // log.debug("Request body:", options.body);
     }
 
+    if (body && additionalHeaders['content-type'].startsWith('multipart/form-data;')) {
+      options.headers = {
+        ...additionalHeaders,
+        'X-API-Key': this.apiKey
+      };
+      options.body = body;
+    }
+
     const response = await nodeFetch(`${this.baseUrl}${endpoint}`, options);
 
     // Get response content, parse it if it's JSON
diff --git a/src/services/browser.ts b/src/services/browser.ts
@@ -1,4 +1,6 @@
 import { BaseService } from './base';
+import { ExtensionService } from './extension';
+import { getEnvWithDefault } from '../env';
 import { ICreateBrowser, ICreateBrowserResponse } from '../types';
 
 // Define default parameters
@@ -9,8 +11,13 @@ const DEFAULT_BROWSER_OPTIONS: ICreateBrowser = {
 };
 
 export class BrowserService extends BaseService {
+  public readonly extension: ExtensionService;
+
   constructor(apiKey: string, baseUrl: string, timeout: number = 30_000) {
     super(apiKey, baseUrl, timeout);
+
+    const baseApiURL = getEnvWithDefault('SCRAPELESS_BASE_API_URL', 'https://api.scrapeless.com');
+    this.extension = new ExtensionService(apiKey, baseApiURL, timeout);
   }
 
   /**
@@ -30,7 +37,8 @@ export class BrowserService extends BaseService {
       session_recording: data.session_recording?.toString(),
       proxy_country: data.proxy_country,
       proxy_url: data.proxy_url,
-      fingerprint: data.fingerprint ? JSON.stringify(data.fingerprint) : undefined
+      fingerprint: data.fingerprint ? JSON.stringify(data.fingerprint) : undefined,
+      extension_ids: data.extension_ids
     };
 
     if (data.proxy_url) {
diff --git a/src/services/extension.ts b/src/services/extension.ts
@@ -0,0 +1,96 @@
+import fs from 'node:fs';
+import FormData from 'form-data';
+import { BaseService } from './base';
+
+import { BrowserExtension, UploadExtensionResponse, ExtensionDetail, ExtensionListItem } from '../types';
+
+export class ExtensionService extends BaseService implements BrowserExtension {
+  constructor(apiKey: string, baseUrl: string, timeout: number) {
+    super(apiKey, baseUrl, timeout);
+  }
+
+  /**
+   * Validates the file path and extracts the file name.
+   * @param filePath The path to the file.
+   * @returns The extracted file name.
+   * @throws Error if the file suffix is not valid.
+   */
+  private getFileName(filePath: string): string {
+    const validSuffixes = ['.zip'];
+    const fileSuffix = filePath.slice(filePath.lastIndexOf('.')).toLowerCase();
+    if (!validSuffixes.includes(fileSuffix)) {
+      throw new Error(`Invalid file suffix: ${fileSuffix}. Supported suffixes: ${validSuffixes.join(', ')}`);
+    }
+
+    return filePath.slice(filePath.lastIndexOf('/') + 1);
+  }
+
+  async upload(filePath: string, name: string): Promise<UploadExtensionResponse> {
+    const fileName = this.getFileName(filePath);
+    const fileStream = fs.createReadStream(filePath);
+
+    const formData = new FormData();
+    formData.append('file', fileStream, fileName);
+    formData.append('name', name);
+
+    const res = await this.request<UploadExtensionResponse, true>(
+      '/browser/extensions/upload',
+      'POST',
+      formData,
+      formData.getHeaders(),
+      true
+    );
+
+    return res.data;
+  }
+
+  async update(extensionId: string, filePath: string, name?: string): Promise<{ success: boolean }> {
+    const fileName = this.getFileName(filePath);
+    const fileStream = fs.createReadStream(filePath);
+
+    const formData = new FormData();
+    formData.append('file', fileStream, fileName);
+    if (name) {
+      formData.append('name', name);
+    }
+
+    const res = await this.request<{ success: boolean }, true>(
+      `/browser/extensions/${extensionId}`,
+      'PUT',
+      formData,
+      formData.getHeaders(),
+      true
+    );
+
+    return res.data;
+  }
+
+  async get(extensionId: string): Promise<ExtensionDetail> {
+    const res = await this.request<ExtensionDetail, true>(
+      `/browser/extensions/${extensionId}`,
+      'GET',
+      undefined,
+      {},
+      true
+    );
+
+    return res.data;
+  }
+
+  async list(): Promise<ExtensionListItem[]> {
+    const res = await this.request<ExtensionListItem[], true>('/browser/extensions/list', 'GET', undefined, {}, true);
+    return res.data;
+  }
+
+  async delete(extensionId: string): Promise<{ success: boolean }> {
+    const res = await this.request<{ success: boolean }, true>(
+      `/browser/extensions/${extensionId}`,
+      'DELETE',
+      undefined,
+      {},
+      true
+    );
+
+    return res.data;
+  }
+}
diff --git a/src/types/browser.ts b/src/types/browser.ts
@@ -14,6 +14,7 @@ export interface ICreateBrowser {
   proxy_country?: string;
   proxy_url?: string;
   fingerprint?: object;
+  extension_ids?: string;
 }
 
 /**
diff --git a/src/types/extension.ts b/src/types/extension.ts
@@ -0,0 +1,32 @@
+export interface UploadExtensionResponse {
+  extensionId: string;
+  name: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface ExtensionListItem {
+  extensionId: string;
+  name: string;
+  version: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface ExtensionDetail {
+  extensionId: string;
+  teamId: string;
+  manifestName: string;
+  name: string;
+  version: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface BrowserExtension {
+  upload: (filePath: string, name: string) => Promise<UploadExtensionResponse>;
+  update: (extensionId: string, filePath: string, name?: string) => Promise<{ success: boolean }>;
+  get: (extensionId: string) => Promise<ExtensionDetail>;
+  list: () => Promise<ExtensionListItem[]>;
+  delete: (extensionId: string) => Promise<{ success: boolean }>;
+}
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -11,3 +11,4 @@ export * from './actor';
 export * from './runner';
 export * from './storage';
 export * from './scraping-crawl';
+export * from './extension';

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ export interface ICreateBrowser {`
`14`	`14`	`proxy_country?: string;`
`15`	`15`	`proxy_url?: string;`
`16`	`16`	`fingerprint?: object;`
	`17`	`+ extension_ids?: string;`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`/**`