@bytexbyte/nxtlinq-ai-agent-sdk 1.2.2 → 1.2.4

package/README.md

@@ -1,113 +1,124 @@
 # Nxtlinq AI Agent SDK
 
-A powerful SDK for building intelligent conversation applications with Nxtlinq AI Agent.
+A powerful AI Agent SDK that supports multiple AI model switching, wallet connection, permission management, and more.
 
 ## Features
 
-- 💬 Real-time chat interface with AI Agent
-- 🎯 Preset messages for quick interactions
-- 🛠️ Tool integration support
-- 🔄 Automatic retry mechanism for failed requests
-- 📱 Responsive and modern UI design
-- 🎨 Customizable styling
-- 🔌 Easy integration with React applications
-- 🔒 Secure authentication and API key management
-- 👛 MetaMask wallet integration
-- 🔐 AIT (AI Identity Token) management
-- 🔑 Permission-based access control
-- 🔍 Enhanced error handling and debugging
-- ⚡ Improved async operation handling
-- 🔔 Unified notification system with Modal prompts
+- 🤖 **Multiple AI Models Support**: Supports Nova, Claude, ChatGPT, Llama, Gemini, and other AI models
+- 🔄 **Real-time Model Switching**: Users can switch AI models at any time during conversations
+- 👛 **Wallet Integration**: Supports MetaKeep wallet connection and verification
+- 🔐 **Permission Management**: AIT (AI Identity Token) based permission control system
+- 💬 **Real-time Chat**: Context-aware conversation functionality
+- 🎨 **Customizable UI**: Complete UI components and style customization options
 
 ## Installation
 
 ```bash
-npm install @bytexbyte/nxtlinq-ai-agent-sdk@1.1.9
+npm install nxtlinq-ai-agent-sdk
 # or
-yarn add @bytexbyte/nxtlinq-ai-agent-sdk@1.1.9
+yarn add nxtlinq-ai-agent-sdk
 ```
 
-## Quick Start
+## Basic Usage
+
+### 1. Basic Configuration
 
 ```tsx
-import { ChatBot } from '@bytexbyte/nxtlinq-ai-agent-sdk';
+import { ChatBot } from 'nxtlinq-ai-agent-sdk';
 
 function App() {
-  const handleMessage = (message) => {
-    console.log('Received new message:', message);
-  };
-
-  const handleToolUse = async (toolUse) => {
-    console.log('Tool use:', toolUse);
-    return {
-      id: Date.now().toString(),
-      content: 'Tool execution response',
-      role: 'assistant',
-      timestamp: new Date().toISOString()
-    };
-  };
-
-  const presetMessages = [
-    { text: 'Hello, how can you help me?' },
-    { text: 'I want to add a new member' },
-    { text: 'I want to view the analytics page' },
-    { text: 'I want to change my name' }
-  ];
-
   return (
     <ChatBot
       serviceId="your-service-id"
       apiKey="your-api-key"
       apiSecret="your-api-secret"
-      onMessage={handleMessage}
-      onToolUse={handleToolUse}
-      presetMessages={presetMessages}
-      onVerifyWallet={async () => {
-        // Implement Berify.me verification
-        return { token: 'verification-token' };
-      }}
     />
   );
 }
 ```
 
-> **Note**: The SDK now includes a unified notification system. All success, error, warning, and info messages are displayed as Modal prompts in the top-right corner, providing a consistent and non-intrusive user experience.
-
-## Berify.me Integration
-
-The SDK supports Berify.me wallet verification for enhanced security:
+### 2. Custom AI Models
 
 ```tsx
-import { ChatBot } from '@bytexbyte/nxtlinq-ai-agent-sdk';
+import { ChatBot, DEFAULT_AI_MODELS } from 'nxtlinq-ai-agent-sdk';
 
 function App() {
-  const handleVerifyWallet = async () => {
-    // Open Berify.me verification modal
-    const modal = window.open(
-      'https://berify.me/verify',
-      'BerifyMeModal',
-      'width=500,height=600'
-    );
+  // Custom available AI models
+  const customModels = [
+    { label: 'Nova', value: 'nova' },
+    { label: 'Claude', value: 'claude' },
+    { label: 'ChatGPT', value: 'open-ai' },
+    // Add more models...
+  ];
 
-    return new Promise((resolve) => {
-      const handleMessage = (event) => {
-        if (event.origin === 'https://berify.me' && event.data.type === 'VERIFICATION_SUCCESS') {
-          window.removeEventListener('message', handleMessage);
-          modal?.close();
-          resolve({ token: event.data.token });
-        }
-      };
+  return (
+    <ChatBot
+      serviceId="your-service-id"
+      apiKey="your-api-key"
+      apiSecret="your-api-secret"
+      availableModels={customModels}
+      defaultModelIndex={1} // Default to Claude
+      showModelSelector={true}
+      onModelChange={(model) => {
+        console.log('Switched to:', model.label);
+      }}
+    />
+  );
+}
+```
 
-      window.addEventListener('message', handleMessage);
-    });
-  };
+### 3. Advanced Configuration
+
+```tsx
+import { ChatBot } from 'nxtlinq-ai-agent-sdk';
 
+function App() {
   return (
     <ChatBot
       serviceId="your-service-id"
       apiKey="your-api-key"
       apiSecret="your-api-secret"
-      onVerifyWallet={handleVerifyWallet}
+      // AI Model configuration
+      availableModels={DEFAULT_AI_MODELS}
+      defaultModelIndex={0}
+      showModelSelector={true}
+      onModelChange={(model) => {
+        console.log('Model changed to:', model.label);
+      }}
+      // Preset messages
+      presetMessages={[
+        { text: 'Hello, how can you help me?', autoSend: true },
+        { text: 'I want to know about your services.', autoSend: false }
+      ]}
+      // Callback functions
+      onMessage={(message) => {
+        console.log('New message:', message);
+      }}
+      onError={(error) => {
+        console.error('Error:', error);
+      }}
+      onToolUse={async (toolUse) => {
+        console.log('Tool used:', toolUse);
+        // Handle tool calls
+        return {
+          id: Date.now().toString(),
+          content: 'Tool executed successfully',
+          role: 'assistant',
+          timestamp: new Date().toISOString()
+        };
+      }}
+      // Wallet verification
+      onVerifyWallet={async () => {
+        // Custom wallet verification logic
+        return { token: 'your-token' };
+      }}
+      // Permission group
+      permissionGroup="default"
+      // UI configuration
+      placeholder="Type your message..."
+      className="custom-chatbot"
+      maxRetries={3}
+      retryDelay={1000}
     />
   );
 }
@@ -115,168 +126,239 @@ function App() {
 
 ## API Reference
 
-### ChatBot Component Props
-
-| Prop | Type | Required | Description |
-|------|------|----------|-------------|
-| serviceId | string | Yes | Your Nxtlinq service ID |
-| apiKey | string | Yes | Your Nxtlinq API key |
-| apiSecret | string | Yes | Your Nxtlinq API secret |
-| onMessage | (message: Message) => void | No | Callback when a new message is received |
-| onError | (error: Error) => void | No | Callback when an error occurs |
-| onToolUse | (toolUse: ToolUse) => Promise<Message \| void> | No | Callback for handling tool usage |
-| onVerifyWallet | () => Promise<{ token: string } \| undefined> | Yes | Callback for wallet verification |
-| presetMessages | PresetMessage[] | No | Array of preset messages to display |
-| placeholder | string | No | Input placeholder text (default: "Type a message...") |
-| className | string | No | Additional CSS class name |
-| maxRetries | number | No | Maximum number of retry attempts (default: 3) |
-| retryDelay | number | No | Delay between retries in milliseconds (default: 1000) |
-| permissionGroup | string | No | Permission group name for filtering permissions |
+### ChatBot Props
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `serviceId` | `string` | - | Service ID (required) |
+| `apiKey` | `string` | - | API Key (required) |
+| `apiSecret` | `string` | - | API Secret (required) |
+| `availableModels` | `AIModel[]` | `DEFAULT_AI_MODELS` | Available AI models list |
+| `defaultModelIndex` | `number` | `0` | Default selected model index |
+| `showModelSelector` | `boolean` | `true` | Whether to show model selector |
+| `onModelChange` | `(model: AIModel) => void` | - | Model change callback |
+| `presetMessages` | `PresetMessage[]` | `[]` | Preset messages list |
+| `placeholder` | `string` | `'Type a message...'` | Input placeholder |
+| `className` | `string` | `''` | Custom CSS class name |
+| `maxRetries` | `number` | `3` | Maximum retry attempts |
+| `retryDelay` | `number` | `1000` | Retry delay (milliseconds) |
+| `onMessage` | `(message: Message) => void` | - | Message callback |
+| `onError` | `(error: Error) => void` | - | Error callback |
+| `onToolUse` | `(toolUse: ToolUse) => Promise<Message \| void>` | - | Tool use callback |
+| `onVerifyWallet` | `() => Promise<{token: string} \| undefined>` | - | Wallet verification callback |
+| `permissionGroup` | `string` | - | Permission group name |
+
+### AIModel Type
 
-### Notification System
+```typescript
+interface AIModel {
+  label: string;  // Display name
+  value: string;  // Model identifier
+}
+```
 
-The SDK includes a unified notification system that displays Modal prompts for various operations:
+### Default AI Models
 
-- **Success Notifications**: Green modal for successful operations (auto-hide after 3 seconds)
-- **Error Notifications**: Red modal for error messages (auto-hide after 5 seconds)
-- **Warning Notifications**: Orange modal for warnings (auto-hide after 4 seconds)
-- **Info Notifications**: Blue modal for informational messages (auto-hide after 3 seconds)
+```typescript
+const DEFAULT_AI_MODELS = [
+  { label: 'Nova', value: 'nova' },
+  { label: 'Claude', value: 'claude' },
+  { label: 'ChatGPT', value: 'open-ai' },
+  { label: 'Llama', value: 'llama' },
+  { label: 'Gemini', value: 'gemini' },
+];
+```
 
-All notifications appear in the top-right corner and can be manually dismissed by clicking the × button.
+## Component Usage
 
-## Types
+### Using Components Individually
 
-### Message
-```typescript
-interface Message {
-  id: string;
-  content: string;
-  role: 'user' | 'assistant';
-  timestamp: string;
-  button?: string;
-  error?: string;
+```tsx
+import { 
+  ChatBotProvider, 
+  ChatBotUI, 
+  ModelSelector,
+  MessageList,
+  MessageInput 
+} from 'nxtlinq-ai-agent-sdk';
+
+function CustomChatBot() {
+  return (
+    <ChatBotProvider
+      serviceId="your-service-id"
+      apiKey="your-api-key"
+      apiSecret="your-api-secret"
+    >
+      <div className="custom-chatbot-container">
+        <ChatBotUI />
+      </div>
+    </ChatBotProvider>
+  );
 }
 ```
 
-### PresetMessage
-```typescript
-interface PresetMessage {
-  text: string;
-  autoSend?: boolean;
+### Custom Layout
+
+```tsx
+import { 
+  ChatBotProvider, 
+  useChatBot,
+  ModelSelector,
+  MessageList,
+  MessageInput 
+} from 'nxtlinq-ai-agent-sdk';
+
+function CustomLayout() {
+  const { isOpen, setIsOpen } = useChatBot();
+
+  if (!isOpen) {
+    return (
+      <button onClick={() => setIsOpen(true)}>
+        Open Chat
+      </button>
+    );
+  }
+
+  return (
+    <div className="custom-layout">
+      <header>
+        <h3>AI Assistant</h3>
+        <ModelSelector />
+        <button onClick={() => setIsOpen(false)}>Close</button>
+      </header>
+      <MessageList />
+      <MessageInput />
+    </div>
+  );
 }
-```
 
-### ToolUse
-```typescript
-interface ToolUse {
-  name: string;
-  input: Record<string, any>;
+function App() {
+  return (
+    <ChatBotProvider
+      serviceId="your-service-id"
+      apiKey="your-api-key"
+      apiSecret="your-api-secret"
+    >
+      <CustomLayout />
+    </ChatBotProvider>
+  );
 }
 ```
 
-### AIT
-```typescript
-interface AIT {
-  aitId: string;
-  controller: string;
-  metadata: AITMetadata;
-  metadataHash: string;
-  metadataCid: string;
-}
+## Style Customization
+
+### CSS Classes
 
-interface AITMetadata {
-  model: string;
-  permissions: string[];
-  issuedBy: string;
-  serviceId?: string;
+```css
+/* Main container */
+.nxtlinq-chatbot-container {
+  /* Custom styles */
 }
-```
 
-### ServicePermission
-```typescript
-interface ServicePermission {
-  id: string;
-  label: string;
-  description: string;
-  groups: string[];
+/* Message list */
+.nxtlinq-message-list {
+  /* Custom styles */
 }
-```
 
-## Features
+/* User message */
+.nxtlinq-user-message {
+  /* Custom styles */
+}
 
-### Wallet Integration
-- MetaMask wallet connection
-- Berify.me wallet verification
-- Wallet-based authentication
-- AIT (AI Identity Token) generation and management
-
-### Authentication Flow
-1. Connect MetaMask wallet
-2. Verify wallet ownership (optional, via Berify.me)
-3. Sign in with wallet
-4. Generate and register AIT with required permissions
-5. Use AIT for authenticated operations
-
-### Enhanced Error Handling
-- Improved async operation handling
-- Better state management
-- Detailed error messages
-- Comprehensive debugging logs
+/* AI message */
+.nxtlinq-ai-message {
+  /* Custom styles */
+}
 
-## Error Handling
+/* Model selector */
+.nxtlinq-model-selector {
+  /* Custom styles */
+}
+```
 
-The SDK includes enhanced error handling with:
-- Automatic retry mechanism for failed requests
-- Error callback for custom error handling
-- User-friendly error messages
-- Wallet connection error handling
-- Authentication error handling
-- Detailed console logging for debugging
+### Inline Style Override
 
-## Best Practices
+```tsx
+<ChatBot
+  serviceId="your-service-id"
+  apiKey="your-api-key"
+  apiSecret="your-api-secret"
+  className="my-custom-chatbot"
+  style={{
+    '--primary-color': '#007bff',
+    '--secondary-color': '#6c757d',
+    '--border-radius': '10px'
+  }}
+/>
+```
 
-1. Implement proper wallet verification logic
-2. Handle AIT permissions appropriately
-3. Set appropriate timeout values
-4. Implement error retry mechanisms
-5. Use context management to maintain conversation coherence
-6. Handle wallet connection errors gracefully
-7. Implement proper error handling for authentication flow
-8. Monitor console logs for debugging
+## Event Handling
 
-## Troubleshooting
+### Model Change Events
 
-Having issues? Check our [Troubleshooting Guide](./TROUBLESHOOTING.md) which includes:
+```tsx
+<ChatBot
+  serviceId="your-service-id"
+  apiKey="your-api-key"
+  apiSecret="your-api-secret"
+  onModelChange={(model) => {
+    console.log('Model changed to:', model.label);
+    // You can add analytics tracking here
+    analytics.track('model_changed', {
+      model: model.value,
+      label: model.label
+    });
+  }}
+/>
+```
 
-- Common problems and solutions
-- Authentication debugging steps
-- Permission issue resolution
-- Best practice recommendations
+### Message Events
 
-### Common Issues
+```tsx
+<ChatBot
+  serviceId="your-service-id"
+  apiKey="your-api-key"
+  apiSecret="your-api-secret"
+  onMessage={(message) => {
+    console.log('New message:', message);
+    // You can add message storage or analytics here
+    if (message.role === 'user') {
+      analytics.track('user_message', {
+        content: message.content,
+        model: message.metadata?.model
+      });
+    }
+  }}
+/>
+```
 
-**Q: Still need to sign in after connecting wallet?**
-A: This is usually due to expired authentication tokens or address mismatches. Check browser console logs and refer to the [Troubleshooting Guide](./TROUBLESHOOTING.md) for detailed solutions.
+## Error Handling
 
-**Q: Cannot use specific AI tool features?**
-A: Check AIT permission settings to ensure required tool permissions are included. See [Troubleshooting Guide](./TROUBLESHOOTING.md) for details.
+```tsx
+<ChatBot
+  serviceId="your-service-id"
+  apiKey="your-api-key"
+  apiSecret="your-api-secret"
+  onError={(error) => {
+    console.error('ChatBot error:', error);
+    // You can add error reporting here
+    errorReporting.captureException(error);
+  }}
+/>
+```
 
-## Changelog
+## Best Practices
 
-### v1.1.9
-- 🔧 Fixed async operation timing issues in wallet connection
-- 🐛 Improved state management for AIT validation
-- 📝 Enhanced error messages and debugging logs
-- ⚡ Better handling of authentication flow
+1. **Model Selection**: Choose appropriate AI models based on use cases
+2. **Error Handling**: Always provide `onError` callback to handle errors
+3. **User Experience**: Use preset messages to guide users
+4. **Performance Optimization**: Set reasonable retry counts and delays
+5. **Security**: Keep API keys secure and use environment variables
 
 ## License
 
-Proprietary - All Rights Reserved
-
-Copyright (c) 2025 ByteXByte. All rights reserved.
-
-This software and associated documentation files (the "Software") are proprietary and confidential. The Software is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties.
+MIT License
 
-Unauthorized copying, distribution, modification, public display, or public performance of the Software is strictly prohibited. The Software may only be used in accordance with the terms of a valid license agreement with ByteXByte.
+## Support
 
-For licensing inquiries, please contact: [Your Contact Information] 
+For questions or suggestions, please submit an Issue or contact our support team. 

package/dist/api/nxtlinq-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nxtlinq-api.d.ts","sourceRoot":"","sources":["../../src/api/nxtlinq-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAK1C,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,EAAE,WAAW,MAAM,KAAG,MAwJpE,CAAC"}
+{"version":3,"file":"nxtlinq-api.d.ts","sourceRoot":"","sources":["../../src/api/nxtlinq-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AA6L1C,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,EAAE,WAAW,MAAM,KAAG,MASpE,CAAC"}