@eko-ai/eko 1.0.15-alpha.2 → 1.0.15-alpha.4

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 FellouAI
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 FellouAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -123,6 +123,8 @@ Eko can be used in multiple environments:
 
 - Report issues on [GitHub Issues](https://github.com/FellouAI/eko/issues)
 - Join our [slack community discussions](https://join.slack.com/t/eko-ai/shared_invite/zt-2xhvkudv9-nHvD1g8Smp227sM51x_Meg)
+- Join our [Discard](https://discord.gg/XpFfk2e5):
+![](discard.png)
 - Contribute tools and improvements
 - Share your use cases and feedback
 

package/dist/common/chrome/proxy.d.ts

@@ -1,12 +1,12 @@
 /**
- * Sets a proxy for the Chrome API.
+ * Get a proxy for the Chrome API by mockClass.
  * This function creates a proxy for the Chrome API, allowing for interception and modification of certain methods.
  * The main logic involves creating a proxy for the `chrome.tabs` and `chrome.windows` namespaces.
  * If a method exists in the mock implementation (e.g., `tabs_get`), it will be used; otherwise, the original Chrome API method will be called.
- * @param chromeProxy - An object that provides mock implementations of Chrome API methods.
+ * @param mockClass - A **class** that provides mock implementations of Chrome API methods.
  * @example
  * ```typescript
- * class MyChromeProxy {
+ * class MyMockClass {
  *   public static tabs_get(tabId: number): Promise<chrome.tabs.Tab> {
  *     console.log(tabId);
  *     return chrome.tabs.get(tabId);
@@ -16,20 +16,9 @@
  *     return chrome.windows.create(createData);
  *   }
  * }
- * setChromeProxy(MyChromeProxy);
+ * let p = createChromeApiProxy(MyMockClass);
+ * p.windows.create(...);
  * ```
  * In this example, `tabs_get` is a mock implementation that logs the `tabId` before calling the original `chrome.tabs.get` method, and the same as `chrome.windows.create` method.
  */
-export declare function setChromeProxy(chromeProxy: any): void;
-/**
- * Retrieves the current Chrome API proxy.
- * This function returns the proxy object created by `setChromeProxy`, which can be used to access the proxied Chrome API methods.
- * @returns The proxied Chrome API object.
- * @example
- * ```typescript
- * const chrome = getChromeProxy();
- * chrome.tabs.get(1).then(tab => console.log(tab));
- * ```
- * In this example, `getChromeProxy` is used to retrieve the proxied Chrome API object, and then `tabs.get` is called on it.
- */
-export declare function getChromeProxy(): any;
+export declare function createChromeApiProxy(mockClass: any): any;

package/dist/common/summarize-workflow.d.ts

@@ -0,0 +1,2 @@
+import { LLMProvider, WorkflowSummary, Workflow, NodeOutput } from "@/types";
+export declare function summarizeWorkflow(llmProvider: LLMProvider, workflow: Workflow, contextVariables: Map<string, unknown>, nodeOutputs: NodeOutput[]): Promise<WorkflowSummary>;

package/dist/common/tools/document_agent.d.ts

@@ -0,0 +1,8 @@
+import { Tool, InputSchema, ExecutionContext, DocumentAgentToolInput, DocumentAgentToolOutput } from '@/types';
+export declare class DocumentAgentTool implements Tool<DocumentAgentToolInput, DocumentAgentToolOutput> {
+    name: string;
+    description: string;
+    input_schema: InputSchema;
+    constructor();
+    execute(context: ExecutionContext, params: DocumentAgentToolInput): Promise<DocumentAgentToolOutput>;
+}

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

@@ -1,4 +1,5 @@
 import { CancelWorkflow } from "./cancel_workflow";
 import { HumanInputText, HumanInputSingleChoice, HumanInputMultipleChoice, HumanOperate } from "./human";
 import { SummaryWorkflow } from "./summary_workflow";
-export { CancelWorkflow, HumanInputText, HumanInputSingleChoice, HumanInputMultipleChoice, HumanOperate, SummaryWorkflow, };
+import { DocumentAgentTool } from "./document_agent";
+export { CancelWorkflow, HumanInputText, HumanInputSingleChoice, HumanInputMultipleChoice, HumanOperate, SummaryWorkflow, DocumentAgentTool, };

package/dist/common/tools/write_context.d.ts

@@ -0,0 +1,7 @@
+import { Tool, InputSchema, ExecutionContext } from "@/types";
+export declare class WriteContextTool implements Tool<any, any> {
+    name: string;
+    description: string;
+    input_schema: InputSchema;
+    execute(context: ExecutionContext, params: unknown): Promise<unknown>;
+}

package/dist/core/eko.d.ts

@@ -1,4 +1,4 @@
-import { LLMConfig, EkoConfig, EkoInvokeParam, Tool, Workflow, WorkflowCallback, NodeOutput } from '../types';
+import { LLMConfig, EkoConfig, EkoInvokeParam, Tool, Workflow, WorkflowCallback, WorkflowResult } from '../types';
 /**
  * Eko core
  */
@@ -9,9 +9,10 @@ export declare class Eko {
     private toolRegistry;
     private workflowGeneratorMap;
     constructor(llmConfig: LLMConfig, ekoConfig?: EkoConfig);
+    private buildEkoConfig;
     private registerTools;
     generate(prompt: string, param?: EkoInvokeParam): Promise<Workflow>;
-    execute(workflow: Workflow): Promise<NodeOutput[]>;
+    execute(workflow: Workflow): Promise<WorkflowResult>;
     cancel(workflow: Workflow): Promise<void>;
     modify(workflow: Workflow, prompt: string): Promise<Workflow>;
     private getTool;

package/dist/extension/core.d.ts

@@ -1,6 +1,6 @@
 import { Tool } from '../types';
-export declare function pub(tabId: number, event: string, params: any): Promise<any>;
-export declare function getLLMConfig(name?: string): Promise<{
+export declare function pub(chromeProxy: any, tabId: number, event: string, params: any): Promise<any>;
+export declare function getLLMConfig(chromeProxy: any, name?: string): Promise<{
     llm?: string;
     apiKey?: string;
     modelName?: string;

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

@@ -9,7 +9,7 @@ declare function get_clickable_elements(doHighlightElements: any | undefined, in
 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 create_selector_map(element_tree: any, ignore_element_obj: any): {};
 declare function parse_node(node_data: any, parent: any): {
     tagName: any;
     xpath: any;

package/dist/extension/script/build_dom_tree.js

@@ -9,7 +9,7 @@ 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);
+  let selector_map = create_selector_map(element_tree, true);
   let element_str = clickable_elements_to_string(element_tree, includeAttributes);
   return { element_str, selector_map };
 }
@@ -105,12 +105,12 @@ function clickable_elements_to_string(element_tree, includeAttributes) {
   return formatted_text.join('\n');
 }
 
-function create_selector_map(element_tree) {
+function create_selector_map(element_tree, ignore_element_obj) {
   let selector_map = {};
   function process_node(node) {
     if (node.tagName) {
       if (node.highlightIndex != null) {
-        selector_map[node.highlightIndex] = node;
+        selector_map[node.highlightIndex] = ignore_element_obj ? { xpath: node.xpath } : node;
       }
       for (let i = 0; i < node.children.length; i++) {
         process_node(node.children[i]);

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

@@ -1,22 +1,22 @@
 import { ScreenshotResult } from '../../types/tools.types';
-export declare function type(tabId: number, text: string, coordinate?: [number, number]): 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(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(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(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(tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
-export declare function screenshot(windowId: number, compress?: boolean): Promise<ScreenshotResult>;
+export declare function type(chromeProxy: any, tabId: number, text: string, coordinate?: [number, number]): Promise<any>;
+export declare function type_by(chromeProxy: any, tabId: number, text: string, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function clear_input(chromeProxy: any, tabId: number, coordinate?: [number, number]): Promise<any>;
+export declare function clear_input_by(chromeProxy: any, tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function mouse_move(chromeProxy: any, tabId: number, coordinate: [number, number]): Promise<any>;
+export declare function left_click(chromeProxy: any, tabId: number, coordinate?: [number, number]): Promise<any>;
+export declare function left_click_by(chromeProxy: any, tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function right_click(chromeProxy: any, tabId: number, coordinate?: [number, number]): Promise<any>;
+export declare function right_click_by(chromeProxy: any, tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function double_click(chromeProxy: any, tabId: number, coordinate?: [number, number]): Promise<any>;
+export declare function double_click_by(chromeProxy: any, tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function screenshot(chromeProxy: any, windowId: number, compress?: boolean): Promise<ScreenshotResult>;
 export declare function compress_image(dataUrl: string, scale?: number, quality?: number): Promise<string>;
-export declare function scroll_to(tabId: number, coordinate: [number, number]): 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<{
+export declare function scroll_to(chromeProxy: any, tabId: number, coordinate: [number, number]): Promise<any>;
+export declare function scroll_to_by(chromeProxy: any, tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function get_dropdown_options(chromeProxy: any, tabId: number, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function select_dropdown_option(chromeProxy: any, tabId: number, text: string, xpath?: string, highlightIndex?: number): Promise<any>;
+export declare function cursor_position(chromeProxy: any, tabId: number): Promise<{
     coordinate: [number, number];
 }>;
-export declare function size(tabId?: number): Promise<[number, number]>;
+export declare function size(chromeProxy: any, tabId?: number): Promise<[number, number]>;

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

@@ -9,5 +9,5 @@ import { Screenshot } from './screenshot';
 import { TabManagement } from './tab_management';
 import { WebSearch } from './web_search';
 import { RequestLogin } from './request_login';
-export * from '../../universal_tools';
+export * from '../../common/tools';
 export { BrowserUse, ElementClick, ExportFile, ExtractContent, FindElementPosition, OpenUrl, GetAllTabs, Screenshot, TabManagement, WebSearch, RequestLogin, };

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

@@ -5,6 +5,6 @@ export declare class RequestLogin implements Tool<any, any> {
     input_schema: InputSchema;
     constructor();
     execute(context: ExecutionContext, params: any): Promise<any>;
-    awaitLogin(tabId: number, task_id: string): Promise<boolean>;
+    awaitLogin(chromeProxy: any, tabId: number, task_id: string): Promise<boolean>;
     isLoginIn(context: ExecutionContext): Promise<boolean>;
 }

package/dist/extension/utils.d.ts

@@ -1,14 +1,14 @@
 import { ExecutionContext } from '../types/action.types';
 export declare function getWindowId(context: ExecutionContext): Promise<number>;
 export declare function getTabId(context: ExecutionContext): Promise<number>;
-export declare function getCurrentTabId(windowId?: number | undefined): Promise<number | undefined>;
-export declare function open_new_tab(url: string, newWindow: boolean, windowId?: number): Promise<chrome.tabs.Tab>;
-export declare function executeScript(tabId: number, func: any, args: any[]): Promise<any>;
-export declare function waitForTabComplete(tabId: number, timeout?: number): Promise<chrome.tabs.Tab>;
-export declare function doesTabExists(tabId: number): Promise<unknown>;
-export declare function getPageSize(tabId?: number): Promise<[number, number]>;
+export declare function getCurrentTabId(chromeProxy: any, windowId?: number | undefined): Promise<number | undefined>;
+export declare function open_new_tab(chromeProxy: any, url: string, newWindow: boolean, windowId?: number): Promise<chrome.tabs.Tab>;
+export declare function executeScript(chromeProxy: any, tabId: number, func: any, args: any[]): Promise<any>;
+export declare function waitForTabComplete(chromeProxy: any, tabId: number, timeout?: number): Promise<chrome.tabs.Tab>;
+export declare function doesTabExists(chromeProxy: any, tabId: number): Promise<unknown>;
+export declare function getPageSize(chromeProxy: any, tabId?: number): Promise<[number, number]>;
 export declare function sleep(time: number): Promise<void>;
-export declare function injectScript(tabId: number, filename?: string): Promise<void>;
+export declare function injectScript(chromeProxy: any, tabId: number, filename?: string): Promise<void>;
 export declare class MsgEvent {
     eventMap: {
         [key: string]: Function;