openkbs 0.0.23 → 0.0.25

package/Docs.md

@@ -475,7 +475,7 @@ Here's a breakdown of the key objects and utilities available within the OpenKBS
 
 * **`openkbs`:** The OpenKBS SDK, documented previously, provides utility functions for interacting with the OpenKBS platform and various external services.
 
-* **`AWS: AWS_SDK`:**  The AWS SDK provides access to a wide range of AWS services directly within your event handlers.  This allows integration with S3, DynamoDB, Lambda, and other AWS resources.  Pre-configured and ready to use.
+* **`AWS: AWS_SDK`:**  The AWS SDK provides access to a wide range of AWS services
 
 * **`axios`:**  Powerful HTTP client for making requests to external APIs and services.  Simplifies handling responses and errors compared to the built-in `https` module.
 

package/README.md

@@ -1,11 +1,7 @@
 # OpenKBS · [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/open-kbs/openkbs-chat/blob/main/LICENSE) [![npm version](https://img.shields.io/badge/npm-v0.0.20-orange.svg)](https://www.npmjs.com/package/openkbs)
 
-OpenKBS is an extendable open-source platform designed to build, 
-deploy and integrate AI agents anywhere, from websites to IoT devices. 
-Its event-driven architecture enables full customization of backend and 
-frontend components, while the LLM abstraction layer allows seamless
-switching between language models. With its powerful CLI, OpenKBS turns
-complex tasks into simple prompt commands, letting developers focus on what matters.
+OpenKBS is an extendable AI service designed to build, 
+deploy and integrate AI agents and applications.
 
 ## Table of Contents
 
@@ -34,6 +30,16 @@ complex tasks into simple prompt commands, letting developers focus on what matt
         - [Frontend Module Loading](#frontend-module-loading)
         - [Built-in UI Libraries](#built-in-ui-libraries)
         - [Common Frontend Components and Utilities](#common-frontend-components-and-utilities)
+- [API](#api)
+    - [Keys and Authentication](#keys-and-authentication)
+    - [Encryption and Decryption](#encryption-and-decryption)
+    - [API Endpoints](#api-endpoints)
+        - [Agent newChat](#newChat)
+        - [Agent getChatMessages](#getChatMessages)
+        - [Agent chatAddMessages](#chatAddMessages)
+        - [Ledger signTransaction](#signTransaction)
+        - [Ledger accountBalances](#account-balances)
+        - [Ledger transactions](#transactions)
 - [License](#license)
 - [Contributing](#contributing)
 - [Contact](#contact)
@@ -979,6 +985,225 @@ const onRenderChatMessage = async (params) => {
 };
 ```
 
+## API
+
+OpenKBS provides APIs to interact programmatically with your application. These APIs allow you to perform actions like starting new chats, retrieving chat messages, and managing data within your application. Data exchanged with these APIs is encrypted and decrypted using AES-256 encryption.
+
+### Keys and Authentication
+
+- **kbId**: Agent ID from OpenKBS app > Access > kbId.
+- **apiKey**: API key from OpenKBS app > Access > API Keys.
+- **AESKey**: Encryption key from OpenKBS app > Access > AES Key.
+
+### Encryption and Decryption
+
+OpenKBS utilizes AES-256 encryption to secure sensitive data. The encryption process involves generating a salt, deriving a key and initialization vector (IV) from a passphrase using a key derivation function (KDF), and then encrypting the data using AES-256 in CBC mode. The encrypted data is then prepended with the salt and a marker, and finally base64 encoded.  Decryption reverses this process.
+
+**Example in JavaScript (using CryptoJS):**
+
+```javascript
+import CryptoJS from 'crypto-js';
+
+export const encrypt = (text, AESKey) => {
+    return CryptoJS.AES.encrypt(text, AESKey).toString();
+};
+
+export const decrypt = (ciphertext, AESKey) => {
+    const bytes = CryptoJS.AES.decrypt(ciphertext, AESKey);
+    return bytes.toString(CryptoJS.enc.Utf8);
+};
+```
+
+### API Endpoints
+
+#### newChat
+
+This endpoint initiates a new task (chat session) with a specific title and initial message.
+
+-  **Endpoint:** `https://chat.openkbs.com/`
+-  **Method:** `POST`
+-  **Request Body (JSON):**
+
+```json
+{
+  "kbId": "YOUR_KB_ID",
+  "apiKey": "YOUR_API_KEY",
+  "chatTitle": "Chat Title",
+  "encrypted": true,
+  "message": "Initial task content (must be encrypted)" 
+}
+```
+
+**Response (JSON):**
+
+```json
+[
+  {
+    "createdChatId": "1737908556342-603701"
+  },
+  { "id":1, "content": "other content"}
+]
+```
+
+
+#### getChatMessages
+
+This endpoint retrieves messages from a specified chat.
+
+-  **Endpoint:** `https://chat.openkbs.com/`
+-  **Method:** `POST`
+-  **Request Body (JSON):**
+
+```json
+{
+  "action": "getChatMessages",
+  "kbId": "YOUR_KB_ID",
+  "apiKey": "YOUR_API_KEY",
+  "chatId": "createdChatId"
+}
+```
+
+**Response (JSON):**
+
+```json
+[
+  {
+    "data": {
+      "messages": [
+        {
+          "content": "Message content (encrypted)",
+          "role": "sender_role (e.g., 'user', 'assistant')",
+          "msgId": "message_id"
+        },
+        // ... other messages
+      ]
+    }
+  }
+]
+```
+
+#### signTransaction
+
+This endpoint is used to sign a JWT, which is necessary for accessing the ledger endpoint to retrieve transactions and account balances.
+
+-  **Endpoint:** `https://kb.openkbs.com/`
+-  **Method:** `POST`
+-  **Request Body (JSON):**
+
+```json
+{
+  "kbId": "YOUR_KB_ID",
+  "action": "signTransaction",
+  "apiKey": "YOUR_API_KEY"
+}
+```
+
+- **Response:**
+
+The response contains a signed JWT used for authenticating requests to the ledger and account balance endpoints.
+
+
+```json
+{
+  "transactionJWT": "xxx"
+}
+```
+
+#### accountBalances
+
+This endpoint retrieves the account balance for a specific resource, such as credits.
+
+-  **Endpoint:** `https://ledger.openkbs.com/account-balances`
+-  **Method:** `POST`
+-  **Request Body (JSON):**
+
+```json
+{
+  "apiKey": "YOUR_API_KEY",
+  "transactionJWT": "SIGNED_JWT_FROM_SIGN_TRANSACTION"
+}
+```
+
+- **Response:**
+
+The response is a JSON object containing account balance details:
+
+```json
+{
+  "balance": 1000000, // 1000 credits === 1 cent
+  "accountId": "0000da3b669a3426019ffc8ddae93c2e",
+  "resourceId": "credits",
+  "lastTransactionSubject": "kbId",
+  "userId": "xxx646594380230f",
+  "accountName": "User Account"
+}
+```
+
+#### transactions
+
+This endpoint retrieves a list of transactions associated with the specified agent.
+
+-  **Endpoint:** `https://ledger.openkbs.com/transactions`
+-  **Method:** `POST`
+-  **Request Body (JSON):**
+
+```json
+{
+  "lastEvaluatedKey": null,
+  "limit": 25, // or any specified limit
+  "apiKey": "YOUR_API_KEY",
+  "transactionJWT": "SIGNED_JWT_FROM_SIGN_TRANSACTION"
+}
+```
+
+- **Response:**
+
+The response is a JSON object containing a `transactions` array. Each transaction object includes:
+
+```json
+{
+  "transactions": [
+    {
+      "subject": "kbId",
+      "accountId": "0000da3b669a3426019ffc8ddae93c2e",
+      "resourceId": "credits",
+      "subjectId": "xxxx2sxeobc9",
+      "amount": -6024,
+      "message": "Input: 11816 tokens, Output: 649 tokens",
+      "remoteAccount": "xxx1b21a831389b59bbc263face0e41d",
+      "transactionId": "1737909703561-305239"
+    }
+    // ... other transactions
+  ]
+}
+```
+
+#### chatAddMessages
+
+This endpoint allows adding messages to a specified chat, which is useful for integrating with external systems or logging events.  Combined with the `onAddMessages` event handler, these added messages can trigger actions within your OpenKBS application.
+
+-  **Endpoint:** `https://chat.openkbs.com/`
+-  **Method:** `POST`
+-  **Request Body (JSON):**
+
+```json
+{
+  "action": "chatAddMessages",
+  "chatId": "Chat ID",
+  "messages": [
+    {
+      "role": "Sender role (e.g., 'user', 'assistant', 'system')",
+      "content": "Message content",
+      "msgId": "Unique message ID (recommended to include a timestamp)"
+    },
+    // ... more messages can be added to this array
+  ],
+  "apiKey": "YOUR_API_KEY", // Required for authentication
+  "kbId": "YOUR_KB_ID"
+}
+```
+
+
 
 ## License
 

package/package.json

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

package/src/actions.js

@@ -126,7 +126,7 @@ async function pullAction(location = 'origin', targetFile) {
             }
         }
     } catch (error) {
-        console.red('Error during pull operation:', error.message);
+        console.error('Error during pull operation:', error.message);
     }
 }
 
@@ -241,7 +241,7 @@ async function pushAction(location = 'origin', targetFile, options) {
             }
         }
     } catch (error) {
-        console.red('Error during push operation:', error.message);
+        console.error('Error during push operation:', error.message);
     }
 }
 
@@ -263,7 +263,7 @@ async function cloneAction(kbId) {
         await downloadFiles(['functions', 'frontend'], kbId, kbToken);
         console.green('Cloning complete!');
     } catch (error) {
-        console.red('Error during clone operation:', error.message);
+        console.error('Error during clone operation:', error.message);
     }
 }
 
@@ -280,7 +280,7 @@ async function createByTemplateAction(name) {
 
         console.log(`Application ${name} created successfully.`);
     } catch (error) {
-        console.red(`Error during create operation:`, error.message);
+        console.error(`Error during create operation:`, error.message);
     }
 }
 

package/src/utils.js

@@ -506,14 +506,14 @@ async function signPayload(payload, accountId, publicKey, privateKey, expiresInS
 }
 
 const buildPackage = async (namespace, kbId, moduleName) => {
-    const token = await getClientJWT();
+    const { kbToken } = await fetchKBJWT(kbId);
 
     return await makePostRequest('https://kb.openkbs.com/', {
-        token,
+        token: kbToken,
         kbId,
         namespace,
         moduleName,
-        action:  namespace === 'frontend' ? 'buildWebpackPackage' : 'buildNodePackage'
+        action:  namespace === 'frontend' ? 'buildWebpackPackageWithKBToken' : 'buildNodePackageWithKBToken'
     });
 }
 
@@ -1048,7 +1048,7 @@ async function initByTemplateAction(params) {
             }
         });
     } catch (error) {
-        console.red(`Error during create operation:`, error.message);
+        console.error(`Error during create operation:`, error.message);
     }
 }