@eko-ai/eko 1.0.1 → 1.0.3

package/README.md

@@ -1,70 +1,82 @@
-# **Eko**
+# Eko
 
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)  [![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](https://example.com/build-status)  [![Version](https://img.shields.io/badge/version-0.1.0-yellow.svg)](https://example.com/version)  
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](https://example.com/build-status) [![Version](https://img.shields.io/badge/version-0.1.0-yellow.svg)](https://example.com/version)
 
 **Eko** is a revolutionary framework designed to empower developers and users alike to program their browser and operating system using natural language. With seamless integration of browser APIs, OS-level capabilities, and cutting-edge AI tools like Claude 3.5, Eko redefines how we interact with technology, making it intuitive, powerful, and accessible.
 
----
+## Key Features
 
-## **Table of Contents**
+- **Natural Language Programming**: Transform human instructions into executable actions using advanced AI models
+- **Cross-Platform Operation**: Run in browser extensions, web applications, or Node.js environments
+- **Powerful Tooling**: Built-in tools for browser automation, OS operations, and system control
+- **Flexible Integration**: Seamless integration with Claude 3.5 and other LLM models
+- **Developer-Friendly**: Comprehensive TypeScript support and extensive documentation
 
-1. [Introduction](#introduction)  
-2. [Features](#features)  
-3. [Installation](#installation)  
-4. [Usage](#usage)  
-5. [API Documentation](#api-documentation)  
-6. [Contributing](#contributing)  
-7. [License](#license)  
+## Quick Start
 
----
+```bash
+npm install @eko-ai/eko
+```
 
-## **Introduction**
+```typescript
+import { Eko } from '@eko-ai/eko';
 
-**Eko** is a full-stack agent development framework built on the [Fellou AI browser](https://fellou.ai), which transforms human words into actions. By leveraging natural language processing and advanced AI capabilities, it bridges the gap between user intent and system execution. Whether you're automating workflows, building browser agents, or accessing system-level operations, Eko provides the tools to make it effortless.  
+const eko = new Eko({
+  apiKey: 'your_anthropic_api_key',
+});
 
-## **Why use the Eko**
-- The biggest advantage of using Eko is that developers don’t need to build client software, and users don’t need to install any additional client to enjoy the most advanced AI-powered computer use capabilities. These capabilities span across both the browser and the operating system.
-- **Eko** changes the paradigm of programming, shifting from developers telling computers how to do something to developers telling computers what to do and what goals to achieve.
+// Example: Browser automation
+await eko.run("Search for 'Eko framework' on Google and save the first result");
 
+// Example: System operation
+await eko.run("Create a new folder named 'reports' and move all PDF files there");
+```
 
-### **Key Benefits**
-- **Language as Code**: Use natural language to write commands and create workflows.  
-- **Cross-Platform Integration**: Access browser and operating system APIs seamlessly.  
-- **AI-Powered**: Harness the capabilities of AI systems like Claude 3.5, OpenAI for advanced automation.  
-- **Developer-Friendly**: Simplify complex tasks with an intuitive and flexible framework.  
+## Use Cases
 
----
+- Browser automation and web scraping
+- System file and process management
+- Workflow automation
+- Data processing and organization
+- GUI automation
+- Multi-step task orchestration
 
-## **Features**
+## Documentation
 
-- **Natural Language Programming**: Write code in plain English to interact with your system and browser.  
-- **Unified API Access**: A single interface for browser APIs, OS-level operations, and AI tools.  
-- **Event-Driven Automation**: Trigger workflows based on browser or system events.  
-- **Customizable Agents**: Build intelligent agents to perform repetitive or complex tasks.
-- **AI Integration**: Leverage advanced AI models to understand and execute complex commands.
+Visit our [documentation site](https://eko.fellou.ai/docs) for:
 
----
+- Getting started guide
+- API reference
+- Usage examples
+- Best practices
+- Configuration options
 
-## **Installation**
+## Development Environments
 
-### **Using npm**
+Eko can be used in multiple environments:
 
-```bash
-npm install @eko-ai/eko
-```
+- Browser Extension
+- Web Applications
+- Node.js Applications
+- [Fellou AI Browser](https://fellou.ai)
+
+## Community and Support
+
+- Report issues on [GitHub Issues](https://github.com/FellouAI/eko/issues)
+- Contribute tools and improvements
+- Share your use cases and feedback
+- Join our community discussions
 
 ## Contributing
 
-Contributions are welcome! Please follow these steps to contribute:
+We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) for details on:
 
-1. Fork the repository.
-2. Create a new branch: git checkout -b feature/- your-feature-name.
-3. Make your changes and commit them: git commit -m 'Add some feature'.
-4. Push to the branch: git push origin feature/your-feature-name.
-5. Submit a pull request.
-6. For detailed guidelines, see CONTRIBUTING.md.
+- Setting up the development environment
+- Code style guidelines
+- Submission process
+- Tool development
+- Use case optimization
 
 ## License
-This project is licensed under the MIT License.
 
-## Acknowledgments
+Eko is released under the MIT License. See the [LICENSE](LICENSE) file for details.

package/dist/core/eko.d.ts

@@ -3,6 +3,7 @@ import { EkoConfig, EkoInvokeParam, Tool, Workflow, WorkflowCallback } from '../
  * Eko core
  */
 export declare class Eko {
+    static tools: Map<string, Tool<any, any>>;
     private llmProvider;
     private toolRegistry;
     constructor(config: EkoConfig);

package/dist/core/tool-registry.d.ts

@@ -3,7 +3,7 @@ import { ToolDefinition } from '../types/llm.types';
 export declare class ToolRegistry {
     private tools;
     registerTool(tool: Tool<any, any>): void;
-    unregisterTool(toolName: string): void;
+    unregisterTool(toolName: string): boolean;
     getTool(toolName: string): Tool<any, any>;
     hasTools(toolNames: string[]): boolean;
     getAllTools(): Tool<any, any>[];

package/dist/extension/content/index.d.ts

@@ -1,7 +1,15 @@
 declare const eko: any;
-declare function key(request: any): any;
-declare function type(request: any): any;
+declare function type(request: any): boolean;
 declare function mouse_move(request: any): boolean;
 declare function simulateMouseEvent(request: any, eventTypes: Array<string>, button: 0 | 1 | 2): boolean;
-declare function scroll_to(request: any): void;
-declare function left_click_drag(request: any, steps?: number): boolean;
+declare function scroll_to(request: any): boolean;
+declare function get_dropdown_options(request: any): {
+    options: {
+        index: any;
+        text: any;
+        value: any;
+    }[];
+    id: any;
+    name: any;
+} | null;
+declare function select_dropdown_option(request: any): any;

package/dist/extension/index.d.ts

@@ -3,5 +3,3 @@ import * as utils from './utils';
 export { utils };
 import * as tools from './tools';
 export { tools };
-import * as browser from './tools/browser';
-export { browser };

package/dist/extension/script/build_dom_tree.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Get clickable elements on the page
+ *
+ * @param {*} doHighlightElements Is highlighted
+ * @param {*} includeAttributes [attr_names...]
+ * @returns { element_str, selector_map }
+ */
+declare function get_clickable_elements(doHighlightElements: any | undefined, includeAttributes: any): string;
+declare function get_highlight_element(highlightIndex: any): any;
+declare function remove_highlight(): void;
+declare function clickable_elements_to_string(element_tree: any, includeAttributes: any): string;
+declare function create_selector_map(element_tree: any): {};
+declare function parse_node(node_data: any, parent: any): {
+    tagName: any;
+    xpath: any;
+    highlightIndex: any;
+    attributes: any;
+    isVisible: any;
+    isInteractive: any;
+    isTopElement: any;
+    shadowRoot: any;
+    children: never[];
+    parent: any;
+} | {
+    text: any;
+    isVisible: any;
+    parent: any;
+} | undefined;
+declare function build_dom_tree(doHighlightElements: any): {
+    tagName: any;
+    attributes: {};
+    xpath: string | null;
+    children: never[];
+} | {
+    type: string;
+    text: any;
+    isVisible: boolean;
+} | null;

package/dist/extension/script/build_dom_tree.js

@@ -6,6 +6,7 @@
  * @returns { element_str, selector_map }
  */
 function get_clickable_elements(doHighlightElements = true, includeAttributes) {
+  window.clickable_elements = {};
   let page_tree = build_dom_tree(doHighlightElements);
   let element_tree = parse_node(page_tree);
   let selector_map = create_selector_map(element_tree);
@@ -13,9 +14,10 @@ function get_clickable_elements(doHighlightElements = true, includeAttributes) {
   return { element_str, selector_map };
 }
 
-/**
- * Remove highlight
- */
+function get_highlight_element(highlightIndex) {
+  return window.clickable_elements[highlightIndex];
+}
+
 function remove_highlight() {
   let highlight = document.getElementById('playwright-highlight-container');
   if (highlight) {
@@ -604,6 +606,7 @@ function build_dom_tree(doHighlightElements) {
       // Highlight if element meets all criteria and highlighting is enabled
       if (isInteractive && isVisible && isTop) {
         nodeData.highlightIndex = highlightIndex++;
+        window.clickable_elements[nodeData.highlightIndex] = node;
         if (doHighlightElements) {
           highlightElement(node, nodeData.highlightIndex, parentIframe);
         }
@@ -654,4 +657,5 @@ function build_dom_tree(doHighlightElements) {
 }
 
 window.get_clickable_elements = get_clickable_elements;
+window.get_highlight_element = get_highlight_element;
 window.remove_highlight = remove_highlight;

package/dist/extension/tools/browser.d.ts

@@ -1,20 +1,20 @@
 import { ScreenshotResult } from '../../types/tools.types';
-export declare function key(tabId: number, key: string, coordinate?: [number, number]): Promise<any>;
 export declare function type(tabId: number, text: string, coordinate?: [number, number]): Promise<any>;
-export declare function type_by_xpath(tabId: number, text: string, xpath: string): Promise<any>;
+export declare function type_by(tabId: number, text: string, xpath?: string, highlightIndex?: number): Promise<any>;
 export declare function clear_input(tabId: number, coordinate?: [number, number]): Promise<any>;
-export declare function clear_input_by_xpath(tabId: number, xpath: string): Promise<any>;
+export declare function clear_input_by(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
 export declare function mouse_move(tabId: number, coordinate: [number, number]): Promise<any>;
 export declare function left_click(tabId: number, coordinate?: [number, number]): Promise<any>;
-export declare function left_click_by_xpath(tabId: number, xpath: string): Promise<any>;
-export declare function left_click_drag(tabId: number, coordinate: [number, number]): Promise<any>;
+export declare function left_click_by(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
 export declare function right_click(tabId: number, coordinate?: [number, number]): Promise<any>;
-export declare function right_click_by_xpath(tabId: number, xpath: string): Promise<any>;
+export declare function right_click_by(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
 export declare function double_click(tabId: number, coordinate?: [number, number]): Promise<any>;
-export declare function double_click_by_xpath(tabId: number, xpath: string): Promise<any>;
+export declare function double_click_by(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
 export declare function screenshot(windowId: number): Promise<ScreenshotResult>;
 export declare function scroll_to(tabId: number, coordinate: [number, number]): Promise<any>;
-export declare function scroll_to_xpath(tabId: number, xpath: string): Promise<any>;
+export declare function scroll_to_by(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function get_dropdown_options(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function select_dropdown_option(tabId: number, text: string, xpath?: string, highlightIndex?: number): Promise<any>;
 export declare function cursor_position(tabId: number): Promise<{
     coordinate: [number, number];
 }>;

package/dist/extension/tools/browser_use.d.ts

@@ -15,4 +15,5 @@ export declare class BrowserUse implements Tool<BrowserUseParam, BrowserUseResul
      * @returns > { success: true, image?: { type: 'base64', media_type: 'image/jpeg', data: '/9j...' }, text?: string }
      */
     execute(context: ExecutionContext, params: BrowserUseParam): Promise<BrowserUseResult>;
+    destroy(context: ExecutionContext): void;
 }

package/dist/extension/tools/html_script.d.ts

@@ -1,18 +1,7 @@
 import { ElementRect } from '../../types/tools.types';
 export declare function exportFile(filename: string, type: string, content: string): void;
 export declare function xpath(element: any): string;
-export declare function queryWithXpath(xpath: string): Node | null;
-export declare function queryAllWithXpath(xpath: string): Array<any>;
-export declare function getDropdownOptions(xpath: string): {
-    options: Array<{
-        index: number;
-        text: string;
-        value?: string;
-    }>;
-    id?: string;
-    name?: string;
-} | null;
-export declare function selectDropdownOption(xpath: string, text: string): any;
+export declare function queryWithXpath(xpath: string): any;
 /**
  * Extract the elements related to html operability and wrap them into pseudo-html code.
  */

package/dist/extension/tools/index.d.ts

@@ -3,9 +3,8 @@ import { ElementClick } from './element_click';
 import { ExportFile } from './export_file';
 import { ExtractContent } from './extract_content';
 import { FindElementPosition } from './find_element_position';
-import { FormAutofill } from './form_autofill';
 import { OpenUrl } from './open_url';
 import { Screenshot } from './screenshot';
 import { TabManagement } from './tab_management';
 import { WebSearch } from './web_search';
-export { BrowserUse, ElementClick, ExportFile, ExtractContent, FindElementPosition, FormAutofill, OpenUrl, Screenshot, TabManagement, WebSearch, };
+export { BrowserUse, ElementClick, ExportFile, ExtractContent, FindElementPosition, OpenUrl, Screenshot, TabManagement, WebSearch, };