@eko-ai/eko 1.0.8 → 1.0.10

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

@@ -1,131 +1,139 @@
-
-
-
-<h1 align="center">
-  <a href="https://github.com/FellouAI/eko" target="_blank">
-    <img src="https://github.com/user-attachments/assets/55dbdd6c-2b08-4e5f-a841-8fea7c2a0b92" alt="eko-logo" width="200" height="200">
-  </a>
-  <br>
-  <small>Eko - Build Production-ready Agentic Workflow with Natural Language</small>
-</h1>
-
-
-
-[![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/github/package-json/v/FellouAI/eko?color=yellow)](https://eko.fellou.ai/docs/release/versions/)
-
-Eko (pronounced like ‘echo’) is a production-ready JavaScript framework that enables developers to create reliable agents, **from simple commands to complex workflows**. It provides a unified interface for running agents in both **computer and browser environments**.
-
-# Framework Comparison
-
-| Feature                              | Eko   | Langchain  | Browser-use  | Dify.ai  | Coze   |
-|--------------------------------------|-------|------------|--------------|----------|--------|
-| **Supported Platform**               | **All platform**  | Server side  | Browser  | Web  | Web  |
-| **One sentence to multi-step workflow** | ✅    | ❌          | ✅            | ❌        | ❌      |
-| **Intervenability**                  | ✅    | ✅          | ❌            | ❌        | ❌      | 
-| **Development Efficiency**           | **High**  | Low      | Middle        | Middle    | Low    | 
-| **Task Complexity**           | High  | High      | Low        | Middle    | Middle    | Middle       |
-| **Open-source**                      | ✅    | ✅          | ✅            | ✅        | ❌      |
-| **Access to private web resources** | ✅ **(Coming soon)** | ❌          | ❌            | ❌        | ❌      |
-
-## Quickstart
-
-```bash
-npm install @eko-ai/eko
-```
-
-> For detailed usage, please refer to the [Eko Quickstart guide](https://eko.fellou.ai/docs/getting-started/quickstart/).
-
-```typescript
-import { Eko } from '@eko-ai/eko';
-
-const eko = new Eko({
-  apiKey: 'your_anthropic_api_key',
-});
-
-// Example: Browser automation
-const extWorkflow = await eko.generate("Search for 'Eko framework' on Google and save the first result");
-await eko.execute(extWorkflow);
-
-// Example: System operation
-const sysWorkflow = await eko.generate("Create a new folder named 'reports' and move all PDF files there");
-await eko.execute(sysWorkflow);
-
-```
-
-## Demos
-
-**Propmt:** `Collect the latest NASDAQ data on Yahoo Finance, including price changes, market capitalization, trading volume of major stocks, analyze the data and generate visualization reports`.
-
-https://github.com/user-attachments/assets/4087b370-8eb8-4346-a549-c4ce4d1efec3
-
-Click [here](https://github.com/FellouAI/eko-demos/tree/main/browser-extension-stock) to get the source code.
-
----
-
-**Propmt:** `Based on the README of FellouAI/eko on github, search for competitors, highlight the key contributions of Eko, write a blog post advertising Eko, and post it on Write.as.`
-
-https://github.com/user-attachments/assets/6feaea86-2fb9-4e5c-b510-479c2473d810
-
-Click [here](https://github.com/FellouAI/eko-demos/tree/main/browser-extension-blog) to get the source code.
-
----
-
-**Propmt:** `Clean up all files in the current directory larger than 1MB`
-
-https://github.com/user-attachments/assets/ef7feb58-3ddd-4296-a1de-bb8b6c66e48b
-
-Click [here](https://eko.fellou.ai/docs/computeruse/computer-node/#example-file-cleanup-workflow) to Learn more.
-
----
-
-**Propmt:** Automatic software testing
-```
-    Current login page automation test:
-    1. Correct account and password are: admin / 666666 
-    2. Please randomly combine usernames and passwords for testing to verify if login validation works properly, such as: username cannot be empty, password cannot be empty, incorrect username, incorrect password
-    3. Finally, try to login with the correct account and password to verify if login is successful
-    4. Generate test report and export
-```
-
-https://github.com/user-attachments/assets/7716300a-c51d-41f1-8d4f-e3f593c1b6d5
-
-
-Click [here](https://eko.fellou.ai/docs/browseruse/browser-web#example-login-automation-testing) to Learn more.
-
-## Use Cases
-
-- Browser automation and web scraping
-- System file and process management
-- Workflow automation
-- Data processing and organization
-- GUI automation
-- Multi-step task orchestration
-
-## Documentation
-
-Visit our [documentation site](https://eko.fellou.ai/docs) for:
-
-- Getting started guide
-- API reference
-- Usage examples
-- Best practices
-- Configuration options
-
-## Development Environments
-
-Eko can be used in multiple environments:
-
-- Browser Extension
-- Web Applications
-- Node.js Applications
-
-## Community and Support
-
-- 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)
-- Contribute tools and improvements
-- Share your use cases and feedback
-
-## License
-
-Eko is released under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+
+
+<h1 align="center">
+  <a href="https://github.com/FellouAI/eko" target="_blank">
+    <img src="https://github.com/user-attachments/assets/55dbdd6c-2b08-4e5f-a841-8fea7c2a0b92" alt="eko-logo" width="200" height="200">
+  </a>
+  <br>
+  <small>Eko - Build Production-ready Agentic Workflow with Natural Language</small>
+</h1>
+
+
+
+[![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/github/package-json/v/FellouAI/eko?color=yellow)](https://eko.fellou.ai/docs/release/versions/)
+
+Eko (pronounced like ‘echo’) is a production-ready JavaScript framework that enables developers to create reliable agents, **from simple commands to complex workflows**. It provides a unified interface for running agents in both **computer and browser environments**.
+
+# Framework Comparison
+
+| Feature                              | Eko   | Langchain  | Browser-use  | Dify.ai  | Coze   |
+|--------------------------------------|-------|------------|--------------|----------|--------|
+| **Supported Platform**               | **All platform**  | Server side  | Browser  | Web  | Web  |
+| **One sentence to multi-step workflow** | ✅    | ❌          | ✅            | ❌        | ❌      |
+| **Intervenability**                  | ✅    | ✅          | ❌            | ❌        | ❌      | 
+| **Development Efficiency**           | **High**  | Low      | Middle        | Middle    | Low    | 
+| **Task Complexity**           | **High**  | High      | Low        | Middle    | Middle    | Middle       |
+| **Open-source**                      | ✅    | ✅          | ✅            | ✅        | ❌      |
+| **Access to private web resources** | ✅ | ❌          | ❌            | ❌        | ❌      |
+
+## Quickstart
+
+```bash
+npm install @eko-ai/eko
+```
+
+> For detailed usage, please refer to the [Eko Quickstart guide](https://eko.fellou.ai/docs/getting-started/quickstart/).
+
+```typescript
+import { Eko } from '@eko-ai/eko';
+
+const eko = new Eko({
+  apiKey: 'your_anthropic_api_key',
+});
+
+// Example: Browser automation
+const extWorkflow = await eko.generate("Search for 'Eko framework' on Google and save the first result");
+await eko.execute(extWorkflow);
+
+// Example: System operation
+const sysWorkflow = await eko.generate("Create a new folder named 'reports' and move all PDF files there");
+await eko.execute(sysWorkflow);
+
+```
+
+## Demos
+
+**Prompt:** `Collect the latest NASDAQ data on Yahoo Finance, including price changes, market capitalization, trading volume of major stocks, analyze the data and generate visualization reports`.
+
+https://github.com/user-attachments/assets/4087b370-8eb8-4346-a549-c4ce4d1efec3
+
+Click [here](https://github.com/FellouAI/eko-demos/tree/main/browser-extension-stock) to get the source code.
+
+---
+
+**Prompt:** `Based on the README of FellouAI/eko on github, search for competitors, highlight the key contributions of Eko, write a blog post advertising Eko, and post it on Write.as.`
+
+https://github.com/user-attachments/assets/6feaea86-2fb9-4e5c-b510-479c2473d810
+
+Click [here](https://github.com/FellouAI/eko-demos/tree/main/browser-extension-blog) to get the source code.
+
+---
+
+**Prompt:** `Clean up all files in the current directory larger than 1MB`
+
+https://github.com/user-attachments/assets/ef7feb58-3ddd-4296-a1de-bb8b6c66e48b
+
+Click [here](https://eko.fellou.ai/docs/computeruse/computer-node/#example-file-cleanup-workflow) to Learn more.
+
+---
+
+**Prompt:** Automatic software testing
+```
+    Current login page automation test:
+    1. Correct account and password are: admin / 666666 
+    2. Please randomly combine usernames and passwords for testing to verify if login validation works properly, such as: username cannot be empty, password cannot be empty, incorrect username, incorrect password
+    3. Finally, try to login with the correct account and password to verify if login is successful
+    4. Generate test report and export
+```
+
+https://github.com/user-attachments/assets/7716300a-c51d-41f1-8d4f-e3f593c1b6d5
+
+
+Click [here](https://eko.fellou.ai/docs/browseruse/browser-web#example-login-automation-testing) to Learn more.
+
+## Use Cases
+
+- Browser automation and web scraping
+- System file and process management
+- Workflow automation
+- Data processing and organization
+- GUI automation
+- Multi-step task orchestration
+
+## Documentation
+
+Visit our [documentation site](https://eko.fellou.ai/docs) for:
+
+- Getting started guide
+- API reference
+- Usage examples
+- Best practices
+- Configuration options
+
+## Development Environments
+
+Eko can be used in multiple environments:
+
+- Browser Extension
+- Web Applications
+- Node.js Applications
+
+## Community and Support
+
+- 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)
+- Contribute tools and improvements
+- Share your use cases and feedback
+
+<h1 align="center">
+  <a href="https://github.com/FellouAI/eko" target="_blank">
+    <img width="699" alt="Screenshot 2025-01-22 at 6 41 57 PM" src="https://github.com/user-attachments/assets/88320cc9-1755-4f21-913b-2bfc909e781d" />
+  </a>
+</h1>
+
+[![Star History Chart](https://api.star-history.com/svg?repos=FellouAI/eko&type=Date)](https://star-history.com/#FellouAI/eko&Date)
+
+## License
+
+Eko is released under the MIT License. See the [LICENSE](LICENSE) file for details.

package/dist/core/eko.d.ts

@@ -1,4 +1,4 @@
-import { EkoConfig, EkoInvokeParam, Tool, Workflow, WorkflowCallback } from '../types';
+import { EkoConfig, EkoInvokeParam, Tool, Workflow, WorkflowCallback, NodeOutput } from '../types';
 /**
  * Eko core
  */
@@ -9,7 +9,8 @@ export declare class Eko {
     private workflowGeneratorMap;
     constructor(config: EkoConfig);
     generate(prompt: string, param?: EkoInvokeParam): Promise<Workflow>;
-    execute(workflow: Workflow, callback?: WorkflowCallback): Promise<void>;
+    execute(workflow: Workflow, callback?: WorkflowCallback): Promise<NodeOutput[]>;
+    cancel(workflow: Workflow): Promise<void>;
     modify(workflow: Workflow, prompt: string): Promise<Workflow>;
     private getTool;
     callTool(toolName: string, input: object, callback?: WorkflowCallback): Promise<any>;