esap-aiui-react 1.0.0 → 1.0.1

package/README.md

@@ -1,10 +1,10 @@
 # AIUI React SDK
 
-[![npm version](https://img.shields.io/npm/v/@espai/aiui-react-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@espai/aiui-react-sdk)
-[![npm downloads](https://img.shields.io/npm/dm/@espai/aiui-react-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@espai/aiui-react-sdk)
+[![npm version](https://img.shields.io/npm/v/esap-aiui-react.svg?style=flat-square)](https://www.npmjs.com/package/esap-aiui-react)
+[![npm downloads](https://img.shields.io/npm/dm/esap-aiui-react.svg?style=flat-square)](https://www.npmjs.com/package/esap-aiui-react)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg?style=flat-square)](https://www.typescriptlang.org/)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/espai/aiui-react-sdk/pulls)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/espai/aiui-react/pulls)
 
 **Zero-configuration voice and chat control for React applications through autonomous semantic UI discovery.**
 
@@ -26,11 +26,11 @@ The SDK implements a **hybrid discovery engine** combining MutationObserver-base
 - **Privacy-preserving architecture** — Client-side filtering with configurable redaction patterns
 - **Multi-backend AI support** — Compatible with OpenAI GPT-4, Anthropic Claude, Google Gemini, and local models
 
-```markdown
+
 ## Architecture
 
 ![AIUI Architecture](./assets/architecture-diagram.png)
-```
+
 ### Protocol Design
 
 The SDK implements a multi-channel WebSocket architecture to optimize for both latency and bandwidth:
@@ -46,7 +46,7 @@ This separation prevents JSON parsing overhead from blocking time-sensitive audi
 ## Installation
 
 ```bash
-npm install @espai/aiui-react-sdk
+npm install esap-aiui-react
 ```
 
 ### Prerequisites
@@ -151,17 +151,121 @@ your-application/
 │   ├── worklet-processor.js   # Microphone input processor
 │   └── index.html
 ├── src/
+│   ├── aiui.config.json       # AIUI configuration (REQUIRED)
 │   └── App.tsx
 └── package.json
 ```
 
+### Required: AIUI Configuration File
+
+You **must create** an `aiui.config.json` file in your **`src/`** directory. This file defines how the AIUI SDK connects to your backend and which actions are allowed on each page.
+
+#### Create `src/aiui.config.json`:
+
+```json
+{
+  "applicationId": "your-app-name",
+  "serverUrl": "http://localhost:8000",
+  "apiKey": "your-secret-key",
+  
+  "pages": [
+    {
+      "route": "/",
+      "title": "Home Page",
+      "safeActions": ["click", "fill", "navigate"],
+      "dangerousActions": []
+    },
+    {
+      "route": "/dashboard",
+      "title": "Dashboard",
+      "safeActions": ["view", "filter", "export"],
+      "dangerousActions": ["delete"]
+    },
+    {
+      "route": "/users/:id/edit",
+      "title": "Edit User",
+      "safeActions": ["edit", "save"],
+      "dangerousActions": ["delete user", "deactivate"]
+    }
+  ],
+  
+  "safetyRules": {
+    "requireConfirmation": [
+      "delete user",
+      "delete item",
+      "cancel order"
+    ],
+    "blockedSelectors": [
+      "input[type=\"password\"]",
+      "[data-sensitive=\"true\"]",
+      ".admin-only"
+    ],
+    "allowedDomains": [
+      "localhost",
+      "yourdomain.com"
+    ]
+  },
+  
+  "privacy": {
+    "exposePasswords": false,
+    "exposeCreditCards": false,
+    "redactPatterns": [
+      "[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,}",
+      "\\b\\d{3}[-.]?\\d{3}[-.]?\\d{4}\\b"
+    ]
+  }
+}
+```
+
+#### Configuration Properties:
+
+| Property | Required | Description |
+|----------|----------|-------------|
+| `applicationId` | ✅ | Unique identifier for your application |
+| `serverUrl` | ✅ | Backend API endpoint (WebSocket server URL) |
+| `apiKey` | ✅ | Authentication key for backend connection |
+| `pages` | ✅ | Array of page routes with allowed actions |
+| `safetyRules` | ❌ | Safety configurations for dangerous actions |
+| `privacy` | ❌ | Privacy settings for sensitive data |
+
+#### Page Configuration Details:
+
+Each page in the `pages` array defines:
+- `route`: URL path (supports dynamic routes like `/users/:id`)
+- `title`: Human-readable page name
+- `safeActions`: Actions users can perform via voice/chat (e.g., "click submit", "fill email")
+- `dangerousActions`: Actions requiring user confirmation before execution
+
+#### Load the configuration in your app:
+
+```tsx
+import { AIUIProvider } from 'esap-aiui-react';
+import aiuiConfig from './aiui.config.json';
+
+function App() {
+  return (
+    <AIUIProvider config={aiuiConfig}>
+      <YourApplication />
+    </AIUIProvider>
+  );
+}
+```
+
+**Why this file is required:**
+- ✅ Backend connection - SDK needs `serverUrl` and `apiKey` to connect
+- ✅ Route mapping - Defines which actions are available on each page
+- ✅ Security - Prevents dangerous actions without confirmation
+- ✅ Navigation - Enables voice commands like "navigate to dashboard"
+
+Without this file, the SDK cannot connect to your backend or understand your application's structure.
+
 ## Quick Start
 
 ### Basic Integration
 
 ```tsx
-import { AIUIProvider, useAIUI } from '@espai/aiui-react-sdk';
-import type { AIUIConfig } from '@espai/aiui-react-sdk';
+import { AIUIProvider, useAIUI } from 'esap-aiui-react';
+import type { AIUIConfig } from 'esap-aiui-react';
 
 const config: AIUIConfig = {
   applicationId: 'production-app-v1',
@@ -204,7 +308,7 @@ function App() {
 ### Voice Control Component
 
 ```tsx
-import { useAIUI } from '@espai/aiui-react-sdk';
+import { useAIUI } from 'esap-aiui-react';
 
 function VoiceController() {
   const { 
@@ -238,7 +342,7 @@ function VoiceController() {
 ### Chat Interface Component
 
 ```tsx
-import { useAIUI } from '@espai/aiui-react-sdk';
+import { useAIUI } from 'esap-aiui-react';
 import { useState } from 'react';
 
 function ChatController() {
@@ -486,7 +590,7 @@ interface ChatMessage {
 Execute UI actions programmatically without voice input:
 
 ```typescript
-import { useAIUI } from '@espai/aiui-react-sdk';
+import { useAIUI } from 'esap-aiui-react';
 
 function DataTable() {
   const { executeAction } = useAIUI();
@@ -536,7 +640,7 @@ function DataTable() {
 Combine both voice and chat interfaces for flexible user interaction:
 
 ```tsx
-import { useAIUI } from '@espai/aiui-react-sdk';
+import { useAIUI } from 'esap-aiui-react';
 import { useState } from 'react';
 
 function AIAssistant() {
@@ -751,7 +855,7 @@ The `data-select-options` attribute defines available options using `|||` as a d
 ### Programmatic Navigation
 
 ```typescript
-import { useAIUI } from '@espai/aiui-react-sdk';
+import { useAIUI } from 'esap-aiui-react';
 
 function NavigationHandler() {
   const { executeAction } = useAIUI();
@@ -1267,8 +1371,8 @@ We welcome contributions from the community. Please review our contribution guid
 
 ```bash
 # Clone repository
-git clone https://github.com/espai/aiui-react-sdk.git
-cd aiui-react-sdk
+git clone https://github.com/espai/aiui-react.git
+cd aiui-react
 
 # Install dependencies
 npm install
@@ -1329,7 +1433,7 @@ If you use AIUI in academic research, please cite:
   title={AIUI: Autonomous Voice-Controlled UI Framework with Zero-Configuration Semantic Discovery},
   author={Atik, Md Mahabube Alahi},
   year={2025},
-  url={https://www.npmjs.com/package/@espai/aiui-react-sdk},
+  url={https://www.npmjs.com/package/esap-aiui-react},
   version={1.0.21}
 }
 ```
@@ -1349,8 +1453,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 ## Support
 
 **Community Support:**
-- GitHub Issues: [Report bugs and request features](https://github.com/espai/aiui-react-sdk/issues)
-- GitHub Discussions: [Community Q&A and ideas](https://github.com/espai/aiui-react-sdk/discussions)
+- GitHub Issues: [Report bugs and request features](https://github.com/espai/aiui-react/issues)
+- GitHub Discussions: [Community Q&A and ideas](https://github.com/espai/aiui-react/discussions)
 - Stack Overflow: Tag questions with `aiui-react`
 
 **Commercial Support:**
@@ -1377,4 +1481,4 @@ Special thanks to early adopters who provided production feedback and contribute
 
 ---
 
-**Built with precision for voice-first web experiences.**
+**Built with precision for voice-first web experiences.**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esap-aiui-react",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "description": "Zero-configuration voice and chat control for React applications through autonomous semantic UI discovery",
   "main": "dist/index.js",