@schmitech/chatbot-api 0.4.4 → 0.4.5

package/README.md

@@ -1,124 +1,51 @@
-# 🤖 Chatbot API Client
+# 🤖 ORBIT Chatbot API Client
 
-A JavaScript/TypeScript client for seamless interaction with the Chatbot server, now supporting API key authentication and session tracking.
-
----
+A TypeScript/JavaScript client for seamless interaction with the ORBIT server, supporting API key authentication and session tracking.
 
 ## 📥 Installation
 
-### 📍 Local Development (npm link)
-
-Use during local development:
-
 ```bash
-npm run build
-npm link
-
-# In your project directory
-npm link @schmitech/chatbot-api
-```
-
-### 📂 Local Directory Install
-
-Direct local installation:
-
-```bash
-npm run build
-npm install /path/to/qa-chatbot-server/api
-```
-
-### 🌐 CDN Integration
-
-Integrate directly into websites via CDN:
-
-```html
-<script type="module">
-  import { configureApi, streamChat } from 'https://cdn.jsdelivr.net/npm/@schmitech/chatbot-api/dist/api.mjs';
-
-  configureApi({
-    apiUrl: 'https://your-api-server.com',
-    apiKey: 'your-api-key',
-    sessionId: 'your-session-id' // Optional
-  });
-
-  async function handleChat() {
-    for await (const response of streamChat('Hello', false)) {
-      console.log(response.text);
-    }
-  }
-</script>
+npm install @schmitech/chatbot-api
 ```
 
----
-
-## ⚙️ Usage
+## ⚙️ Basic Usage
 
-### 🚨 Configuration (Required)
+### Configuration
 
-You must configure the API client before usage:
+First, configure the API client with your server details:
 
-```javascript
+```typescript
 import { configureApi, streamChat } from '@schmitech/chatbot-api';
 
 configureApi({
   apiUrl: 'https://your-api-server.com',
   apiKey: 'your-api-key',
-  sessionId: 'your-session-id' // Optional
+  sessionId: 'optional-session-id' // Optional, for conversation tracking
 });
 ```
 
-### 📖 Basic Example
+### Streaming Chat Example
 
-```javascript
+```typescript
 async function chat() {
-  configureApi({ 
-    apiUrl: 'https://your-api-server.com', 
-    apiKey: 'your-api-key',
-    sessionId: 'user_123_session_456' // Optional
-  });
-
-  for await (const response of streamChat('Hello, how can I help?', false)) {
+  for await (const response of streamChat('Hello, how can I help?', true)) {
     console.log(response.text);
-    if (response.done) console.log('Chat complete!');
-  }
-}
-
-chat();
-```
-
-### 🎙️ Voice-enabled Example
-
-```javascript
-async function chatWithVoice() {
-  configureApi({ 
-    apiUrl: 'https://your-api-server.com', 
-    apiKey: 'your-api-key',
-    sessionId: 'user_123_session_456' // Optional
-  });
-
-  for await (const response of streamChat('Tell me a joke', true)) {
-    if (response.type === 'audio') {
-      console.log('Received audio content');
-    } else {
-      console.log(response.text);
+    if (response.done) {
+      console.log('Chat complete!');
     }
-    if (response.done) console.log('Chat complete!');
   }
 }
-
-chatWithVoice();
 ```
 
----
-
 ## ⚛️ React Integration
 
-Configure once globally:
+Here's how to use the API in a React component:
 
-```jsx
+```tsx
 import React, { useState } from 'react';
 import { configureApi, streamChat } from '@schmitech/chatbot-api';
 
+// Configure once at app startup
 configureApi({
   apiUrl: 'https://your-api-server.com',
   apiKey: 'your-api-key',
@@ -126,15 +53,15 @@ configureApi({
 });
 
 function ChatComponent() {
-  const [messages, setMessages] = useState([]);
+  const [messages, setMessages] = useState<Array<{ text: string; isUser: boolean }>>([]);
   const [input, setInput] = useState('');
 
-  const handleSubmit = async (e) => {
+  const handleSubmit = async (e: React.FormEvent) => {
     e.preventDefault();
     setMessages(prev => [...prev, { text: input, isUser: true }]);
 
     let responseText = '';
-    for await (const response of streamChat(input, false)) {
+    for await (const response of streamChat(input, true)) {
       responseText += response.text;
       setMessages(prev => [...prev, { text: responseText, isUser: false }]);
       if (response.done) break;
@@ -144,91 +71,96 @@ function ChatComponent() {
 
   return (
     <form onSubmit={handleSubmit}>
-      <input value={input} onChange={(e) => setInput(e.target.value)} />
+      <input 
+        value={input} 
+        onChange={(e) => setInput(e.target.value)} 
+        placeholder="Type your message..."
+      />
       <button type="submit">Send</button>
     </form>
   );
 }
-
-export default ChatComponent;
 ```
 
----
-
 ## 📱 Mobile Usage
 
-### 📲 React Native
+### React Native Example
+
+```typescript
+import { configureApi, streamChat } from '@schmitech/chatbot-api';
 
-```javascript
-configureApi({ 
-  apiUrl: 'https://your-api-server.com', 
+// Configure once at app startup
+configureApi({
+  apiUrl: 'https://your-api-server.com',
   apiKey: 'your-api-key',
   sessionId: 'user_123_session_456' // Optional
 });
 
-async function handleChat(message) {
-  for await (const response of streamChat(message, false)) {
-    // Handle response
+async function handleChat(message: string) {
+  for await (const response of streamChat(message, true)) {
+    // Handle streaming response
+    console.log(response.text);
+    if (response.done) {
+      console.log('Chat complete!');
+    }
   }
 }
 ```
 
----
+## 🌐 CDN Integration
 
-## 📚 API Reference
+You can also use the API directly in the browser via CDN:
 
-### `configureApi(config)`
-
-| Parameter | Description | Required |
-|-----------|-------------|----------|
-| `apiUrl`  | Chatbot API URL | ✅ Yes |
-| `apiKey`  | API key for authentication | ✅ Yes |
-| `sessionId` | Session ID for tracking conversations | ❌ No |
-
----
-
-## 📤 Publish to npm
-
-**Build package:**
-
-```bash
-npm run build
-```
+```html
+<script type="module">
+  import { configureApi, streamChat } from 'https://cdn.jsdelivr.net/npm/@schmitech/chatbot-api/dist/api.mjs';
 
-**Test locally (optional):**
+  configureApi({
+    apiUrl: 'https://your-api-server.com',
+    apiKey: 'your-api-key',
+    sessionId: 'your-session-id' // Optional
+  });
 
-```bash
-npm pack --dry-run
+  async function handleChat() {
+    for await (const response of streamChat('Hello', true)) {
+      console.log(response.text);
+    }
+  }
+</script>
 ```
 
-**Update version:**
+## 📚 API Reference
 
-```bash
-npm version [patch|minor|major]
-```
+### `configureApi(config)`
 
-**Publish:**
+Configure the API client with server details.
 
-```bash
-npm publish --access public
-```
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `apiUrl` | string | Yes | Chatbot API server URL |
+| `apiKey` | string | Yes | API key for authentication |
+| `sessionId` | string | No | Session ID for conversation tracking |
 
----
+### `streamChat(message: string, stream: boolean = true)`
 
-## 🛠️ Development
+Stream chat responses from the server.
 
-### 🧪 Testing
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `message` | string | - | The message to send to the chat |
+| `stream` | boolean | true | Whether to stream the response |
 
-```bash
-# Test single query
-npm run test-query "your query" "http://your-api-server.com" "your-api-key" ["your-session-id"]
+Returns an AsyncGenerator that yields `StreamResponse` objects:
 
-# Test multiple queries from JSON file
-npm run test-query-from-pairs questions.json "http://your-api-server.com" "your-api-key" [number_of_questions] ["your-session-id"]
+```typescript
+interface StreamResponse {
+  text: string;    // The text content of the response
+  done: boolean;   // Whether this is the final response
+}
 ```
 
----
-
-## 📃 License
+## 🔒 Security
 
-MIT License - See [LICENSE](LICENSE).
+- Always use HTTPS for your API URL
+- Keep your API key secure and never expose it in client-side code
+- Consider using environment variables for sensitive configuration

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@schmitech/chatbot-api",
     "private": false,
-    "version": "0.4.4",
+    "version": "0.4.5",
     "description": "API client for the ORBIT MCP server",
     "type": "module",
     "main": "./dist/api.cjs",