@foisit/react-wrapper 2.0.1 → 2.1.2

package/README.md

@@ -1,9 +1,41 @@
 # @foisit/react-wrapper
 
-Power your React apps with an AI-driven text assistant.
+[![npm version](https://img.shields.io/npm/v/@foisit/react-wrapper.svg)](https://www.npmjs.com/package/@foisit/react-wrapper)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> **The AI-Powered Conversational Assistant for React Applications**
+
+Transform your React app into an intelligent, voice-ready platform. Foisit provides a drop-in AI layer that understands natural language, manages multi-step workflows, and executes actions—all with zero backend required.
 
 > [!NOTE]
-> 🎙️ **Coming Soon**: Voice recognition and responses are planned for a future release. Current support is focused on text-based interactions and AI intent matching.
+> 🎙️ **Voice Support Status**: Voice recognition and responses are currently in development and will be released in a future update. The current version focuses on high-performance text-based interactions and AI intent matching.
+
+---
+
+## 📋 Table of Contents
+
+- [Features](#-features)
+- [Installation](#-installation)
+- [Quick Start](#-quick-start)
+- [Core Concepts](#-core-concepts)
+- [API Reference](#-api-reference)
+- [Advanced Usage](#-advanced-usage)
+- [Examples](#-examples)
+- [TypeScript Support](#-typescript-support)
+- [Best Practices](#-best-practices)
+
+---
+
+## ✨ Features
+
+- **🧠 Natural Language Understanding** - AI-powered intent matching using GPT-4o mini (proxied securely)
+- **📝 Smart Slot Filling** - Auto-generates forms for missing parameters
+- **⚠️ Critical Action Protection** - Built-in confirmation dialogs for dangerous operations
+- **🎨 Premium UI** - Glassmorphic overlay with dark/light mode support
+- **🔒 Zero Backend Required** - Secure proxy architecture keeps API keys server-side
+- **⚡ React Native** - Uses Hooks, Context API, and modern React patterns
+- **🎯 Type-Safe** - Full TypeScript support with comprehensive types
+- **📱 Responsive** - Works flawlessly on desktop and mobile
 
 ---
 
@@ -13,22 +45,35 @@ Power your React apps with an AI-driven text assistant.
 npm install @foisit/react-wrapper
 ```
 
+### Peer Dependencies
+
+```json
+{
+  "react": "^18.0.0",
+  "react-dom": "^18.0.0"
+}
+```
+
 ---
 
-## 🔧 Basic Setup
+## 🏁 Quick Start
 
-Wrap your application in the `AssistantProvider` to enable the assistant.
+### Step 1: Wrap Your App
 
 ```tsx
+import React from 'react';
 import { AssistantProvider } from '@foisit/react-wrapper';
 
 const config = {
-  introMessage: 'Hi! How can I help?',
+  introMessage: 'Welcome! How can I assist you today?',
   enableSmartIntent: true,
   commands: [
     {
-      command: 'home',
-      action: () => navigate('/'),
+      command: 'navigate to profile',
+      action: () => {
+        window.location.href = '/profile';
+        return 'Navigating to profile...';
+      },
     },
   ],
 };
@@ -40,58 +85,555 @@ function App() {
     </AssistantProvider>
   );
 }
+
+export default App;
+```
+
+### Step 2: Use the Hook
+
+```tsx
+import React from 'react';
+import { useAssistant } from '@foisit/react-wrapper';
+
+function MyComponent() {
+  const assistant = useAssistant();
+
+  return <button onClick={() => assistant.toggle()}>Open Assistant</button>;
+}
 ```
 
 ---
 
-## 🛡️ Critical Actions
+## 🎯 Core Concepts
+
+### 1. Commands
 
-Commands marked as `critical` will automatically trigger a confirmation flow in the UI.
+Commands are the building blocks of your assistant. Each command represents an action users can trigger through natural language.
 
 ```tsx
-const config = {
-  commands: [
+{
+  command: 'delete account',
+  description: 'Permanently delete user account',
+  action: () => accountService.delete()
+}
+```
+
+### 2. Parameters (Slot Filling)
+
+Define parameters and Foisit will automatically generate forms to collect them:
+
+```tsx
+{
+  command: 'create user',
+  description: 'Create a new user account',
+  parameters: [
+    { name: 'username', type: 'string', required: true },
+    { name: 'email', type: 'string', required: true },
+    { name: 'age', type: 'number', required: false }
+  ],
+  action: (params) => userService.create(params)
+}
+```
+
+**Supported Parameter Types:**
+
+- `string` - Text input
+- `number` - Numeric input
+- `date` - Date picker
+- `select` - Dropdown (static or async options)
+
+### 3. Critical Actions
+
+Protect dangerous operations with automatic confirmation dialogs:
+
+```tsx
+{
+  command: 'delete all data',
+  critical: true, // 🔒 Requires confirmation
+  description: 'Permanently delete all application data',
+  action: async () => {
+    await dataService.deleteAll();
+    return '✅ All data deleted successfully.';
+  }
+}
+```
+
+### 4. Select Parameters (Static)
+
+Provide predefined options:
+
+```tsx
+{
+  command: 'set theme',
+  parameters: [{
+    name: 'theme',
+    type: 'select',
+    options: [
+      { label: 'Light Mode', value: 'light' },
+      { label: 'Dark Mode', value: 'dark' },
+      { label: 'Auto', value: 'auto' }
+    ]
+  }],
+  action: (params) => setTheme(params.theme)
+}
+```
+
+### 5. Dynamic Select Parameters
+
+Load options from APIs:
+
+```tsx
+{
+  command: 'assign to user',
+  parameters: [{
+    name: 'userId',
+    type: 'select',
+    getOptions: async () => {
+      const users = await userService.getAll();
+      return users.map(u => ({
+        label: `${u.name} (${u.email})`,
+        value: u.id
+      }));
+    }
+  }],
+  action: (params) => taskService.assign(params.userId)
+}
+```
+
+---
+
+## 📘 API Reference
+
+### `useAssistant()` Hook
+
+React hook for programmatic control:
+
+#### Methods
+
+##### `toggle(onSubmit?, onClose?)`
+
+Opens or closes the assistant overlay.
+
+```tsx
+const assistant = useAssistant();
+
+// Basic usage
+assistant.toggle();
+
+// With callbacks
+assistant.toggle(
+  (userInput) => console.log('User said:', userInput),
+  () => console.log('Assistant closed')
+);
+```
+
+##### `addCommand(command, action?)`
+
+Dynamically add a command at runtime.
+
+```tsx
+// Add a simple command
+assistant.addCommand('refresh data', async () => {
+  await dataService.refresh();
+  return 'Data refreshed!';
+});
+
+// Add a command with full config
+assistant.addCommand({
+  command: 'export report',
+  description: 'Export data as PDF',
+  parameters: [
     {
-      command: 'delete order',
-      critical: true,
-      description: 'cancel and delete your current order',
-      action: () => api.deleteOrder(),
+      name: 'format',
+      type: 'select',
+      options: [
+        { label: 'PDF', value: 'pdf' },
+        { label: 'Excel', value: 'xlsx' },
+      ],
     },
   ],
-};
+  action: async (params) => {
+    await reportService.export(params.format);
+    return `Report exported as ${params.format}`;
+  },
+});
+```
+
+##### `removeCommand(commandPhrase)`
+
+Remove a registered command.
+
+```tsx
+assistant.removeCommand('delete account');
+```
+
+##### `getCommands()`
+
+Get list of all registered command names.
+
+```tsx
+const commands = assistant.getCommands();
+console.log('Available commands:', commands);
 ```
 
 ---
 
-## 🧠 AI Intent Matching
+## 🔧 Configuration Options
+
+### `AssistantConfig`
+
+```typescript
+interface AssistantConfig {
+  // Activation keyword (optional)
+  activationCommand?: string;
+
+  // Welcome message shown when assistant opens
+  introMessage?: string;
 
-Enable `enableSmartIntent: true` to allow the assistant to understand natural language.
+  // Response for unrecognized inputs
+  fallbackResponse?: string;
 
-**User says:** _"Make it dark"_  
-**Matched Command:** `{ command: 'dark mode', keywords: ['lights out', 'dark', 'night'], ... }`
+  // Enable AI-powered natural language understanding
+  enableSmartIntent?: boolean;
+
+  // Input field placeholder text
+  inputPlaceholder?: string;
+
+  // List of commands
+  commands: AssistantCommand[];
+
+  // Floating button configuration
+  floatingButton?: {
+    visible?: boolean;
+    tooltip?: string;
+    customHtml?: string;
+    position?: { bottom: string; right: string };
+  };
+}
+```
 
 ---
 
-## 🛠️ Hook Usage: `useAssistant`
+## 🎨 Advanced Usage
 
-Interact with the assistant instance from any component.
+### Example 1: Multi-Step Booking System with State
 
 ```tsx
+import React, { useState } from 'react';
+import { useAssistant, AssistantProvider } from '@foisit/react-wrapper';
+
+function BookingApp() {
+  const [bookings, setBookings] = useState([]);
+  const assistant = useAssistant();
+
+  React.useEffect(() => {
+    assistant.addCommand({
+      command: 'book appointment',
+      description: 'Schedule a new appointment',
+      parameters: [
+        {
+          name: 'service',
+          type: 'select',
+          required: true,
+          getOptions: async () => {
+            const services = await fetch('/api/services').then((r) => r.json());
+            return services.map((s) => ({
+              label: s.name,
+              value: s.id,
+            }));
+          },
+        },
+        {
+          name: 'date',
+          type: 'date',
+          required: true,
+        },
+        {
+          name: 'notes',
+          type: 'string',
+          required: false,
+        },
+      ],
+      action: async (params) => {
+        const booking = await fetch('/api/bookings', {
+          method: 'POST',
+          body: JSON.stringify(params),
+        }).then((r) => r.json());
+
+        setBookings((prev) => [...prev, booking]);
+        return {
+          type: 'success',
+          message: `✅ Appointment booked for ${params.date}!`,
+        };
+      },
+    });
+  }, [assistant]);
+
+  return (
+    <div>
+      <h1>My Bookings: {bookings.length}</h1>
+      <button onClick={() => assistant.toggle()}>Book New Appointment</button>
+    </div>
+  );
+}
+```
+
+### Example 2: E-Commerce with React Router
+
+```tsx
+import { useNavigate } from 'react-router-dom';
 import { useAssistant } from '@foisit/react-wrapper';
 
-function MyComponent() {
+function ProductSearch() {
+  const navigate = useNavigate();
   const assistant = useAssistant();
 
-  const addTempCommand = () => {
-    assistant.addCommand('surprise me', () => alert('Surprise!'));
-  };
+  React.useEffect(() => {
+    assistant.addCommand({
+      command: 'search products',
+      parameters: [
+        { name: 'query', type: 'string', required: true },
+        {
+          name: 'category',
+          type: 'select',
+          required: false,
+          options: [
+            { label: 'Electronics', value: 'electronics' },
+            { label: 'Clothing', value: 'clothing' },
+            { label: 'Books', value: 'books' },
+          ],
+        },
+        { name: 'minPrice', type: 'number', required: false },
+      ],
+      action: async (params) => {
+        const results = await searchProducts(params);
+        navigate(`/products?q=${params.query}`);
+        return `Found ${results.length} products matching "${params.query}"`;
+      },
+    });
+  }, [assistant, navigate]);
 
-  return <button onClick={addTempCommand}>Add Command</button>;
+  return <div>Search component</div>;
 }
 ```
 
+### Example 3: Form Validation with State Management
+
+```tsx
+import { useState } from 'react';
+import { useAssistant } from '@foisit/react-wrapper';
+
+function AccountManager() {
+  const [user, setUser] = useState(null);
+  const assistant = useAssistant();
+
+  React.useEffect(() => {
+    assistant.addCommand({
+      command: 'create account',
+      parameters: [
+        { name: 'email', type: 'string', required: true },
+        { name: 'password', type: 'string', required: true },
+        { name: 'age', type: 'number', required: true },
+      ],
+      action: async (params) => {
+        // Validation
+        if (params.age < 18) {
+          return {
+            type: 'error',
+            message: '❌ You must be 18 or older to create an account.',
+          };
+        }
+
+        if (!params.email.includes('@')) {
+          return {
+            type: 'error',
+            message: '❌ Please provide a valid email address.',
+          };
+        }
+
+        // Create account
+        try {
+          const newUser = await authService.register(params);
+          setUser(newUser);
+          return {
+            type: 'success',
+            message: '✅ Account created successfully! You can now log in.',
+          };
+        } catch (error) {
+          return {
+            type: 'error',
+            message: `❌ Registration failed: ${error.message}`,
+          };
+        }
+      },
+    });
+  }, [assistant]);
+
+  return <div>{user ? `Welcome ${user.email}` : 'No user'}</div>;
+}
+```
+
+---
+
+## 📝 TypeScript Support
+
+### Full Type Definitions
+
+```tsx
+import { AssistantCommand, InteractiveResponse } from '@foisit/core';
+
+// Type-safe command definition
+const myCommand: AssistantCommand = {
+  command: 'update settings',
+  description: 'Update user preferences',
+  parameters: [
+    {
+      name: 'theme',
+      type: 'select',
+      required: true,
+      options: [
+        { label: 'Light', value: 'light' },
+        { label: 'Dark', value: 'dark' },
+      ],
+    },
+  ],
+  action: async (params: { theme: string }): Promise<InteractiveResponse> => {
+    await settingsService.update(params.theme);
+    return {
+      type: 'success',
+      message: `Theme updated to ${params.theme}`,
+    };
+  },
+};
+```
+
+### Hook Types
+
+```tsx
+import { useAssistant } from '@foisit/react-wrapper';
+
+const assistant = useAssistant();
+// assistant is typed as AssistantServiceType
+```
+
+---
+
+## 🎯 Best Practices
+
+### 1. Cleanup Effects
+
+Always clean up commands when components unmount:
+
+```tsx
+useEffect(() => {
+  assistant.addCommand('temp command', () => 'Done');
+
+  return () => {
+    assistant.removeCommand('temp command');
+  };
+}, [assistant]);
+```
+
+### 2. Dependency Management
+
+Include all dependencies in `useEffect`:
+
+```tsx
+useEffect(() => {
+  assistant.addCommand('navigate', () => {
+    navigate('/page'); // Uses navigate from React Router
+  });
+}, [assistant, navigate]); // ✅ Include navigate
+```
+
+### 3. State Updates
+
+Use functional updates for state changes:
+
+```tsx
+action: async () => {
+  setItems((prev) => [...prev, newItem]); // ✅ Functional update
+  return 'Item added';
+};
+```
+
+### 4. Error Boundaries
+
+Wrap your app with error boundaries:
+
+```tsx
+<ErrorBoundary>
+  <AssistantProvider config={config}>
+    <App />
+  </AssistantProvider>
+</ErrorBoundary>
+```
+
+---
+
+## 🧪 Testing
+
+### Unit Testing with React Testing Library
+
+```tsx
+import { render, screen } from '@testing-library/react';
+import { AssistantProvider } from '@foisit/react-wrapper';
+
+test('renders assistant', () => {
+  render(
+    <AssistantProvider config={{ commands: [] }}>
+      <App />
+    </AssistantProvider>
+  );
+
+  // Test your app with assistant
+});
+```
+
 ---
 
-## 👋 Gesture Activation
+## 🔗 Related Packages
+
+- **[@foisit/core](../core)** - Core engine (auto-installed)
+- **[@foisit/angular-wrapper](../angular-wrapper)** - Angular integration
+- **[@foisit/vue-wrapper](../vue-wrapper)** - Vue integration
+
+---
+
+## 🐛 Troubleshooting
+
+### Hook error: "useAssistant must be used within AssistantProvider"
+
+Make sure your component is wrapped with `<AssistantProvider>`.
+
+### Commands not executing
+
+Check browser console for errors. Ensure `action` functions are returning values or promises.
+
+### TypeScript errors
+
+Make sure you're using React 18+ and have proper type definitions.
+
+---
+
+## 📄 License
+
+MIT © [Foisit](https://github.com/boluwatifee4/foisit)
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) first.
+
+---
+
+## 📬 Support
+
+- 📧 Email: support@foisit.com
+- 💬 Discord: [Join our community](https://discord.gg/foisit)
+- 🐛 Issues: [GitHub Issues](https://github.com/boluwatifee4/foisit/issues)
+
+---
 
-Once integrated, a subtle **"Powered by Foisit"** watermark appears. **Double-click** it to open the chat overlay.
+**Made with ❤️ by the Foisit Team**

package/index.d.ts

@@ -0,0 +1,6 @@
+export * from './lib/react-wrapper';
+export * from './lib/components/AssistantProvider';
+export * from './lib/components/AssistantActivator';
+export * from './lib/hooks/useAssistant';
+export * from './lib/hooks/useAssistantState';
+export * from './lib/services/AssistantService';