simplex-ts 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,80 @@
+# Simplex TypeScript Package Template
+
+A TypeScript package for browser automation and web interaction using Simplex API.
+
+## Features
+
+- Browser automation with high-level commands
+- Session-based interaction
+- Element interaction (click, type, scroll)
+- Content extraction (text, images, bounding boxes)
+- File upload and download capabilities
+- TypeScript support with type definitions
+- Built with modern tooling (ESM + CommonJS output)
+
+## Getting Started
+
+1. Install dependencies:
+```bash
+npm install
+```
+
+2. Build the package:
+```bash
+npm run build
+```
+
+3. Run tests:
+```bash
+npm test
+```
+
+## Usage
+
+```typescript
+import { Simplex } from 'simplex-ts';
+
+// Initialize Simplex with your API key
+const simplex = new Simplex('your-api-key');
+
+// Create a new session
+const [sessionId, livestreamUrl] = await simplex.createSession();
+
+// Navigate to a website
+await simplex.goto('example.com');
+
+// Interact with elements
+await simplex.click('Login button');
+await simplex.type('user@example.com');
+await simplex.pressEnter();
+
+// Extract content
+const text = await simplex.extractText('Welcome message');
+console.log(text);
+
+// Close the session when done
+await simplex.closeSession();
+```
+
+### Available Methods
+
+- `createSession()` - Start a new browser session
+- `goto(url)` - Navigate to a URL
+- `click(elementDescription)` - Click an element
+- `type(text)` - Type text
+- `pressEnter()` - Press Enter key
+- `pressTab()` - Press Tab key
+- `deleteText()` - Delete text
+- `extractBbox(elementDescription)` - Get element bounding box
+- `extractText(elementDescription)` - Extract text from element
+- `extractImage(elementDescription)` - Extract image from element
+- `scroll(pixels)` - Scroll page
+- `wait(milliseconds)` - Wait for specified duration
+- `clickAndUpload(elementDescription, file)` - Click and upload file
+- `clickAndDownload(elementDescription)` - Click and download file
+- `exists(elementDescription)` - Check if element exists
+- `closeSession()` - Close the browser session
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Example function to demonstrate package usage
+ * @param name - The name to greet
+ * @returns A greeting message
+ */
+declare function greet(name: string): string;
+
+export { greet };

package/dist/index.d.ts

@@ -1 +1,8 @@
-export { Simplex } from './simplex';
+/**
+ * Example function to demonstrate package usage
+ * @param name - The name to greet
+ * @returns A greeting message
+ */
+declare function greet(name: string): string;
+
+export { greet };

package/dist/index.js

@@ -1,5 +1,33 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Simplex = void 0;
-var simplex_1 = require("./simplex");
-Object.defineProperty(exports, "Simplex", { enumerable: true, get: function () { return simplex_1.Simplex; } });
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  greet: () => greet
+});
+module.exports = __toCommonJS(index_exports);
+function greet(name) {
+  return `Hello, ${name}!`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  greet
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Example function to demonstrate package usage\n * @param name - The name to greet\n * @returns A greeting message\n */\nexport function greet(name: string): string {\n  return `Hello, ${name}!`;\n}\n\n// Export other functions and types here "],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKO,SAAS,MAAM,MAAsB;AAC1C,SAAO,UAAU,IAAI;AACvB;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,8 @@
+// src/index.ts
+function greet(name) {
+  return `Hello, ${name}!`;
+}
+export {
+  greet
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Example function to demonstrate package usage\n * @param name - The name to greet\n * @returns A greeting message\n */\nexport function greet(name: string): string {\n  return `Hello, ${name}!`;\n}\n\n// Export other functions and types here "],"mappings":";AAKO,SAAS,MAAM,MAAsB;AAC1C,SAAO,UAAU,IAAI;AACvB;","names":[]}

package/package.json

@@ -1,37 +1,37 @@
 {
   "name": "simplex-ts",
-  "version": "1.0.0",
-  "description": "TypeScript client for the Simplex API.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "version": "1.0.2",
+  "description": "A TypeScript package template",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsup",
     "test": "jest",
-    "test:unit": "jest tests/simplex.unit.test.ts",
-    "test:integration": "jest tests/simplex.integration.test.ts",
-    "test:coverage": "jest --coverage",
-    "prepare": "npm run build"
-  },
-  "dependencies": {
-    "axios": "^1.6.0",
-    "dotenv": "^16.4.7",
-    "form-data": "^4.0.0"
+    "dev": "tsup --watch",
+    "clean": "rimraf dist"
   },
+  "keywords": [
+    "typescript",
+    "template"
+  ],
+  "author": "",
+  "license": "MIT",
   "devDependencies": {
-    "@types/jest": "^29.5.0",
-    "@types/node": "^20.8.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.19",
     "jest": "^29.7.0",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.2.0"
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.2",
+    "tsup": "^8.0.2",
+    "typescript": "^5.3.3",
+    "glob": "^10.3.10"
   },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "keywords": [
-    "simplex",
-    "api",
-    "client"
-  ],
-  "license": "MIT"
-}
+  "dependencies": {
+    "axios": "^1.6.7",
+    "dotenv": "^16.4.5"
+  }
+} 

package/dist/simplex.d.ts

@@ -1,32 +0,0 @@
-interface SimplexOptions {
-    apiKey?: string;
-}
-export declare class Simplex {
-    private api_key;
-    private session_id;
-    constructor(apiKeyOrOptions?: string | SimplexOptions);
-    private makeRequest;
-    closeSession(): Promise<void>;
-    createSession(options?: {
-        showInConsole?: boolean;
-        proxies?: boolean;
-        sessionData?: string;
-    }): Promise<string>;
-    goto(url: string, cdpUrl?: string): Promise<void>;
-    click(elementDescription: string, cdpUrl?: string): Promise<string>;
-    type(text: string, cdpUrl?: string): Promise<void>;
-    pressEnter(cdpUrl?: string): Promise<void>;
-    pressTab(cdpUrl?: string): Promise<void>;
-    deleteText(cdpUrl?: string): Promise<void>;
-    extractBbox(elementDescription: string, cdpUrl?: string): Promise<any>;
-    extractText(elementDescription: string, cdpUrl?: string): Promise<string>;
-    extractImage(elementDescription: string, cdpUrl?: string): Promise<string>;
-    scroll(pixels: number, cdpUrl?: string): Promise<void>;
-    wait(milliseconds: number, cdpUrl?: string): Promise<void>;
-    createLoginSession(url: string, proxies?: boolean): Promise<string>;
-    restoreLoginSession(sessionData: string, cdpUrl?: string): Promise<void>;
-    clickAndUpload(elementDescription: string, filePath: string): Promise<void>;
-    clickAndDownload(elementDescription: string): Promise<[string, string]>;
-    exists(elementDescription: string, cdpUrl?: string): Promise<[boolean, string]>;
-}
-export {};

package/dist/simplex.js

@@ -1,399 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Simplex = void 0;
-const axios_1 = __importDefault(require("axios"));
-const fs_1 = __importDefault(require("fs"));
-const form_data_1 = __importDefault(require("form-data"));
-const dotenv_1 = __importDefault(require("dotenv"));
-// Load environment variables
-dotenv_1.default.config();
-const BASE_URL = "https://api.simplex.sh";
-class Simplex {
-    constructor(apiKeyOrOptions) {
-        this.session_id = null;
-        // Handle different ways of passing the API key
-        if (typeof apiKeyOrOptions === 'string') {
-            this.api_key = apiKeyOrOptions;
-        }
-        else if (typeof apiKeyOrOptions === 'object') {
-            this.api_key = apiKeyOrOptions.apiKey || '';
-        }
-        else {
-            this.api_key = '';
-        }
-        // Fallback to environment variable if no API key provided
-        if (!this.api_key) {
-            this.api_key = process.env.SIMPLEX_API_KEY || '';
-        }
-        if (!this.api_key) {
-            throw new Error('API key must be provided either through constructor or SIMPLEX_API_KEY environment variable');
-        }
-        // Register cleanup on process exit
-        process.on('exit', () => this.closeSession());
-    }
-    async makeRequest(endpoint, method, data, params, files) {
-        try {
-            const headers = {
-                'x-api-key': this.api_key
-            };
-            const config = {
-                method,
-                url: `${BASE_URL}/${endpoint}`,
-                headers
-            };
-            if (method === 'GET') {
-                config.params = params;
-            }
-            else {
-                if (files) {
-                    const formData = new form_data_1.default();
-                    // Add regular data to form
-                    if (data) {
-                        for (const [key, value] of Object.entries(data)) {
-                            formData.append(key, String(value));
-                        }
-                    }
-                    // Add files to form
-                    for (const [key, fileStream] of Object.entries(files)) {
-                        formData.append(key, fileStream);
-                    }
-                    config.data = formData;
-                    // Add form headers
-                    Object.assign(config.headers, formData.getHeaders());
-                }
-                else {
-                    config.data = data;
-                }
-            }
-            const response = await (0, axios_1.default)(config);
-            console.log('response', response.data);
-            if (endpoint !== 'create_session' && !response.data.hasOwnProperty('succeeded')) {
-                throw new Error(`It looks like the ${endpoint} action failed to return a response. Did you set your api_key when creating the Simplex class?`);
-            }
-            if (endpoint === 'create_session' && !response.data.hasOwnProperty('session_id')) {
-                throw new Error('Create session failed to return a session_id. Did you set your api_key when creating the Simplex class?');
-            }
-            return response.data;
-        }
-        catch (error) {
-            if (error.response) {
-                throw new Error(`Request failed with status ${error.response.status}: ${JSON.stringify(error.response.data)}`);
-            }
-            throw error;
-        }
-    }
-    async closeSession() {
-        if (!this.session_id)
-            return;
-        const formData = new form_data_1.default();
-        formData.append('session_id', this.session_id);
-        const response = await this.makeRequest('close_session', 'POST', formData);
-        this.session_id = null;
-        if (!response.succeeded) {
-            throw new Error(`Failed to close session: ${response.error}`);
-        }
-    }
-    async createSession(options = {}) {
-        const { showInConsole = true, proxies = true, sessionData } = options;
-        const formData = new form_data_1.default();
-        formData.append('proxies', String(proxies));
-        if (sessionData) {
-            formData.append('session_data', sessionData);
-        }
-        const response = await this.makeRequest('create_session', 'POST', formData);
-        if (!response.session_id) {
-            throw new Error("Create session failed to return a session_id. Did you set your api_key when creating the Simplex class?");
-        }
-        this.session_id = response.session_id;
-        const livestreamUrl = response.livestream_url;
-        if (showInConsole) {
-            console.log(`Livestream URL: ${livestreamUrl}`);
-        }
-        return livestreamUrl;
-    }
-    async goto(url, cdpUrl) {
-        if (!url) {
-            throw new Error('URL is required for goto action');
-        }
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action goto with url='${url}'`);
-        }
-        if (!url.startsWith('http://') && !url.startsWith('https://')) {
-            url = 'https://' + url;
-        }
-        const formData = new form_data_1.default();
-        formData.append('url', url);
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('goto', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to goto url: ${response.error}`);
-        }
-    }
-    async click(elementDescription, cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action click with element_description='${elementDescription}'`);
-        }
-        const formData = new form_data_1.default();
-        formData.append('element_description', elementDescription);
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('click', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to click element: ${response.error}`);
-        }
-        return response.element_clicked;
-    }
-    async type(text, cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action type with text='${text}'`);
-        }
-        const formData = new form_data_1.default();
-        formData.append('text', text);
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('type', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to type text: ${response.error}`);
-        }
-    }
-    async pressEnter(cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error('Must call createSession before calling action press_enter');
-        }
-        const formData = new form_data_1.default();
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('press_enter', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to press enter: ${response.error}`);
-        }
-    }
-    async pressTab(cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error('Must call createSession before calling action press_tab');
-        }
-        const formData = new form_data_1.default();
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('press_tab', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to press tab: ${response.error}`);
-        }
-    }
-    async deleteText(cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error('Must call createSession before calling action delete_text');
-        }
-        const formData = new form_data_1.default();
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('delete_text', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to delete text: ${response.error}`);
-        }
-    }
-    async extractBbox(elementDescription, cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action extract_bbox with element_description='${elementDescription}'`);
-        }
-        const formData = new form_data_1.default();
-        formData.append('element_description', elementDescription);
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('extract-bbox', 'GET', undefined, formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to extract bbox: ${response.error}`);
-        }
-        return response.bbox;
-    }
-    async extractText(elementDescription, cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action extract_text with element_description='${elementDescription}'`);
-        }
-        const params = {
-            element_description: elementDescription
-        };
-        if (cdpUrl) {
-            params.cdp_url = cdpUrl;
-        }
-        else {
-            params.session_id = this.session_id;
-        }
-        const response = await this.makeRequest('extract-text', 'GET', undefined, params);
-        if (!response.succeeded) {
-            throw new Error(`Failed to extract text: ${response.error}`);
-        }
-        return response.text;
-    }
-    async extractImage(elementDescription, cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action extract_image with element_description='${elementDescription}'`);
-        }
-        const formData = new form_data_1.default();
-        formData.append('element_description', elementDescription);
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('extract-image', 'GET', undefined, formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to extract image: ${response.error}`);
-        }
-        return response.image;
-    }
-    async scroll(pixels, cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action scroll with pixels=${pixels}`);
-        }
-        const formData = new form_data_1.default();
-        formData.append('pixels', String(pixels));
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('scroll', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to scroll: ${response.error}`);
-        }
-    }
-    async wait(milliseconds, cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action wait with milliseconds=${milliseconds}`);
-        }
-        const formData = new form_data_1.default();
-        formData.append('milliseconds', String(milliseconds));
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('wait', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to wait: ${response.error}`);
-        }
-    }
-    async createLoginSession(url, proxies = true) {
-        const formData = new form_data_1.default();
-        formData.append('url', url);
-        formData.append('proxies', String(proxies));
-        const response = await this.makeRequest('create_login_session', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to create login session: ${response.error}`);
-        }
-        return response.login_session_url;
-    }
-    async restoreLoginSession(sessionData, cdpUrl) {
-        let sessionDataObj;
-        try {
-            sessionDataObj = JSON.parse(sessionData);
-        }
-        catch (_a) {
-            try {
-                sessionDataObj = JSON.parse(await fs_1.default.promises.readFile(sessionData, 'utf-8'));
-            }
-            catch (e) {
-                throw new Error(`Failed to load session data. Input must be valid JSON string or path to JSON file. Error: ${e}`);
-            }
-        }
-        const formData = new form_data_1.default();
-        formData.append('session_data', JSON.stringify(sessionDataObj));
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('restore_login_session', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to restore login session: ${response.error}`);
-        }
-    }
-    async clickAndUpload(elementDescription, filePath) {
-        if (!this.session_id) {
-            throw new Error(`Must call createSession before calling action click_and_upload with element_description='${elementDescription}'`);
-        }
-        const fileStream = fs_1.default.createReadStream(filePath);
-        const formData = new form_data_1.default();
-        formData.append('element_description', elementDescription);
-        formData.append('session_id', this.session_id);
-        formData.append('file', fileStream);
-        try {
-            const response = await this.makeRequest('click_and_upload', 'POST', formData);
-            if (!response.succeeded) {
-                throw new Error(`Failed to click and upload: ${response.error}`);
-            }
-        }
-        finally {
-            fileStream.destroy(); // Clean up the file stream
-        }
-    }
-    async clickAndDownload(elementDescription) {
-        if (!this.session_id) {
-            throw new Error(`Must call createSession before calling action click_and_download with element_description='${elementDescription}'`);
-        }
-        const formData = new form_data_1.default();
-        formData.append('element_description', elementDescription);
-        formData.append('session_id', this.session_id);
-        const response = await this.makeRequest('click_and_download', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to click and download: ${response.error}`);
-        }
-        return [response.b64, response.filename];
-    }
-    async exists(elementDescription, cdpUrl) {
-        if (!cdpUrl && !this.session_id) {
-            throw new Error(`Must call createSession before calling action exists with element_description='${elementDescription}'`);
-        }
-        const formData = new form_data_1.default();
-        formData.append('element_description', elementDescription);
-        if (cdpUrl) {
-            formData.append('cdp_url', cdpUrl);
-        }
-        else {
-            formData.append('session_id', this.session_id);
-        }
-        const response = await this.makeRequest('exists', 'POST', formData);
-        if (!response.succeeded) {
-            throw new Error(`Failed to check if element exists: ${response.error}`);
-        }
-        return [response.exists, response.reasoning];
-    }
-}
-exports.Simplex = Simplex;