openkbs 0.0.31 → 0.0.32

package/MODIFY.md

@@ -15,7 +15,7 @@ A typical OpenKBS project has the following key directories:
 
 *   **`src/`**: Contains your custom source code.
     *   **`Events/`**: Houses backend event handlers.
-        *   `actions.js`: Often used for shared logic/tool definitions (does not have own NPM dependencies).
+        *   `actions.js`: Example file commonly used for shared logic/tools definitions.
         *   `onRequest.js`: Handles incoming user messages before LLM processing.
         *   `onRequest.json`: NPM dependencies for `onRequest.js`.
         *   `onResponse.js`: Handles LLM responses before sending to the user.
@@ -32,52 +32,76 @@ A typical OpenKBS project has the following key directories:
     *   `instructions.txt`: Instructions for the LLM.
     *   `icon.png`: Application icon.
 
+#### Important Coding guidelines
+Organize new features across multiple files (like Events/utils.js) rather than adding everything to actions.js; export functionality from separate modules and import them in actions.js as needed.
+
 #### onRequest and onResponse Handlers
 
 The core of the OpenKBS backend framework revolves around the `onRequest` and `onResponse` event handlers.  
 These handlers act as middleware, intercepting messages before and after they are processed by the LLM.
 
-* **`onRequest` Handler:** This handler is invoked every time a user sends a message to the chat. It provides an opportunity to pre-process the user's input, extract commands and perform actions based on the user's message.
+* **`onRequest` Handler:** This handler is invoked every time a user sends a message to the chat. It provides an opportunity to pre-process the user's input, extract commands and perform actions based on the user's message. The `onRequest.js` file must export a function that receives `request` and `metadata` parameters and returns a modified request object.
+
+* **`onResponse` Handler:** This handler is invoked after the LLM generates a response. It allows post-processing of the LLM's output, execution of commands based on the LLM's intentions. The `onResponse.js` file must export a function that receives `response` and `metadata` parameters and returns a modified response object.
+
+#### NPM Dependencies for Handlers
 
-* **`onResponse` Handler:** This handler is invoked after the LLM generates a response. It allows post-processing of the LLM's output, execution of commands based on the LLM's intentions.
+**Important**: Files with names starting with "on" (like onRequest.js) are entry points for Node.js builds:
+
+1. Each handler has its own build process
+2. If a file imports node-fetch, then node-fetch must be in that handler's JSON file
+3. Example: If utils.js uses node-fetch and is imported by onRequest.js, then node-fetch must be in onRequest.json
 
 
 ## Backend Dependencies
 
 To use external NPM packages in your backend event handlers, you must declare them in the corresponding `.json` file.
-OpenKBS also provides a secure way to handle sensitive information using the `{{secrets.your_secret_name}}` syntax.
 
-**Example: Using axios with an API key**
+**Example: Using https module with an API key**
 
 1. **Declare dependencies** in both `src/Events/onRequest.json` and `src/Events/onResponse.json` (as each handler have separate build):
     ```json
     {
       "dependencies": {
-        "axios": "^1.6.2"
+        "got": "^11.8.5"
       }
     }
     ```
 
-2.  **Implement and use in `src/Events/actions.js`**:
-    ```javascript
-    import axios from 'axios';
-
-    export const getActions = (meta) => {
-        return [
-            [/\/?getNews\("(.*)"\)/, async (match) => {
-                const topic = match[1];
-                const response = await axios.get('https://newsapi.org/v2/everything', {
-                    params: {
-                        q: topic,
-                        apiKey: '{{secrets.news_api_key}}' // Securely injected at runtime
-                    }
-                });
-                return { result: response.data.articles, ...meta };
-            }],
-            // ... other actions
-        ];
-    };
-    ```
+2.  **Implement in any JavaScript file** (actions.js is just an example name):
+
+```javascript
+export const getActions = (meta) => {
+    return [
+        [/\/?getNews\("(.*)"\)/, async (match) => {
+            const { body } = await got(`https://newsapi.org/v2/everything?q=${match[1]}&apiKey={{secrets.news_api_key}}`, 
+                { responseType: 'json' });
+            
+            return { result: body.articles, ...meta };
+        }],
+        // ... other actions
+    ];
+};
+```
+    
 ## Secrets Management
-Define `news_api_key` in your application's secrets manager on the OpenKBS platform.
-The platform will inject the actual value at runtime, keeping your credentials secure while enabling you to make API calls with authenticated services.
+OpenKBS provides a secure way to handle sensitive information using the `{{secrets.your_secret_name}}` syntax.
+Never hardcode secrets in the code, if any secrets are provided by the user replace them with placeholders syntax above.
+The user will later insert the secrets using the secrets manager
+
+#### LLM Instructions
+`app/instructions.txt`
+This file contains the instructions for the agent
+
+**Example Instructions:**
+
+```
+You are an AI assistant.
+
+You can execute the following commands:
+
+/getNews("query")
+Description: """
+Get the latest news
+"""
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openkbs",
-  "version": "0.0.31",
+  "version": "0.0.32",
   "description": "OpenKBS - Command Line Interface",
   "main": "src/index.js",
   "scripts": {

package/src/actions.js

@@ -247,12 +247,31 @@ async function pushAction(location = 'origin', targetFile, options) {
 }
 
 async function cloneAction(kbId) {
+    // Store the original directory so we can restore it if needed
+    const originalDir = process.cwd();
+    
     try {
+        // Create a subdirectory with the name of the kbId
+        const targetDir = path.join(originalDir, kbId);
+        
+        // Check if directory already exists
+        if (fs.existsSync(targetDir)) {
+            console.red(`Directory ${kbId} already exists.`);
+            return;
+        }
+        
+        // Create the subdirectory
+        fs.mkdirSync(targetDir);
+        
+        // Change to the new directory
+        process.chdir(targetDir);
+        
         const localKBData = await fetchLocalKBData({forceInit: true});
 
         if (localKBData?.kbId) {
             console.red(`KB ${localKBData?.kbId} already saved in settings.json.`);
             console.yellow(`To pull the changes from OpenKBS remote use "openkbs pull"`);
+            process.chdir(originalDir); // Change back to original directory
             return;
         }
 
@@ -262,9 +281,18 @@ async function cloneAction(kbId) {
         await fetchAndSaveSettings({ kbId }, kbId, kbToken);
         await downloadIcon(kbId);
         await downloadFiles(['functions', 'frontend'], kbId, kbToken);
-        console.green('Cloning complete!');
+        console.green(`Cloning complete! Files created in directory: ${kbId}`);
     } catch (error) {
         console.error('Error during clone operation:', error.message);
+        // Make sure we return to the original directory in case of error
+        if (process.cwd() !== originalDir) {
+            process.chdir(originalDir);
+        }
+    } finally {
+        // Always ensure we return to the original directory
+        if (process.cwd() !== originalDir) {
+            process.chdir(originalDir);
+        }
     }
 }