esap-aiui-react 1.0.1 → 1.0.2

package/README.md

@@ -6,10 +6,17 @@
 [![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/pulls)
 
-**Zero-configuration voice and chat control for React applications through autonomous semantic UI discovery.**
+**Zero-configuration voice and chat control for any React applications through autonomous semantic UI discovery.**
 
 AIUI React SDK enables natural language interaction with any React application through both voice commands and text chat, without manual UI annotation or intent mapping. The framework employs real-time DOM observation and semantic element discovery to automatically understand your application's interface, allowing users to control your app through conversational voice or text-based commands.
 
+### Enterprise features at a glance
+
+- Security: API-key protected WebSocket channels and safety-rule gates
+- Privacy: client-side redaction and sensitive-field filtering
+- Auditability: server-side action logs and context update tracing
+- Deployment: cloud, private VPC, or fully on-prem
+
 ## Overview
 
 Traditional voice control solutions require extensive manual configuration, predefined intent schemas, or explicit UI element annotation. AIUI eliminates this overhead through a novel semantic discovery architecture that automatically maps UI elements to their contextual meaning, enabling immediate voice interaction with zero setup.
@@ -29,7 +36,7 @@ The SDK implements a **hybrid discovery engine** combining MutationObserver-base
 
 ## Architecture
 
-![AIUI Architecture](./assets/architecture-diagram.png)
+![AIUI Architecture](https://i.imgur.com/Pvmi0Aq.png)
 
 ### Protocol Design
 
@@ -1026,208 +1033,6 @@ The SDK communicates with a backend server implementing the AIUI protocol. The s
 }
 ```
 
-### Reference Server Implementation
-
-```javascript
-const WebSocket = require('ws');
-
-// Create WebSocket server with three endpoints
-const contextServer = new WebSocket.Server({ port: 8080, path: '/context' });
-const audioServer = new WebSocket.Server({ port: 8080, path: '/audio' });
-const chatServer = new WebSocket.Server({ port: 8080, path: '/chat' });
-
-// Session management
-const sessions = new Map();
-
-// Context channel handler
-contextServer.on('connection', (ws, req) => {
-  const url = new URL(req.url, 'ws://localhost');
-  const applicationId = url.searchParams.get('applicationId');
-  const apiKey = url.searchParams.get('apiKey');
-  
-  // Validate API key
-  if (!validateApiKey(apiKey)) {
-    ws.close(1008, 'Invalid API key');
-    return;
-  }
-  
-  console.log(`Context connected: ${applicationId}`);
-  
-  // Store session
-  if (!sessions.has(applicationId)) {
-    sessions.set(applicationId, {});
-  }
-  sessions.get(applicationId).contextWs = ws;
-  
-  ws.on('message', async (data) => {
-    const message = JSON.parse(data.toString());
-    
-    if (message.type === 'context_update' || message.type === 'context_append') {
-      // Store UI context for LLM
-      const session = sessions.get(applicationId);
-      session.uiContext = message.context || message.elements;
-      
-      console.log(`UI context updated: ${session.uiContext.elements?.length || 0} elements`);
-    }
-  });
-  
-  ws.on('close', () => {
-    console.log(`Context disconnected: ${applicationId}`);
-  });
-});
-
-// Audio channel handler (for voice mode)
-audioServer.on('connection', (ws, req) => {
-  const url = new URL(req.url, 'ws://localhost');
-  const applicationId = url.searchParams.get('applicationId');
-  
-  console.log(`Audio connected: ${applicationId}`);
-  
-  const session = sessions.get(applicationId);
-  if (session) {
-    session.audioWs = ws;
-  }
-  
-  let audioBuffer = [];
-  
-  ws.on('message', async (data) => {
-    if (data instanceof Buffer) {
-      // Accumulate audio chunks
-      audioBuffer.push(data);
-      
-      // Process when sufficient audio accumulated (e.g., 1 second)
-      if (audioBuffer.length >= 50) {  // 50 * 20ms = 1 second
-        const audioData = Buffer.concat(audioBuffer);
-        audioBuffer = [];
-        
-        // Send to Speech-to-Text service
-        const transcript = await speechToText(audioData);
-        
-        if (transcript && session?.uiContext) {
-          // Process with LLM
-          const action = await processWithLLM(transcript, session.uiContext);
-          
-          // Send action command via context channel
-          session.contextWs?.send(JSON.stringify({
-            type: 'action',
-            action: action.type,
-            params: action.params,
-            timestamp: new Date().toISOString()
-          }));
-          
-          // Generate TTS response
-          const audioResponse = await textToSpeech(action.response);
-          
-          // Send audio response
-          ws.send(audioResponse);
-        }
-      }
-    }
-  });
-  
-  ws.on('close', () => {
-    console.log(`Audio disconnected: ${applicationId}`);
-  });
-});
-
-// Chat channel handler (for text mode)
-chatServer.on('connection', (ws, req) => {
-  const url = new URL(req.url, 'ws://localhost');
-  const applicationId = url.searchParams.get('applicationId');
-  
-  console.log(`Chat connected: ${applicationId}`);
-  
-  const session = sessions.get(applicationId);
-  if (session) {
-    session.chatWs = ws;
-  }
-  
-  // Confirm connection
-  ws.send(JSON.stringify({ type: 'chat_connected' }));
-  
-  ws.on('message', async (data) => {
-    const message = JSON.parse(data.toString());
-    
-    if (message.type === 'chat_message') {
-      const userMessage = message.content;
-      console.log(`Chat message from ${applicationId}: ${userMessage}`);
-      
-      // Send typing indicator
-      ws.send(JSON.stringify({ type: 'chat_typing', typing: true }));
-      
-      if (session?.uiContext) {
-        // Process with LLM
-        const response = await processWithLLM(userMessage, session.uiContext);
-        
-        // Stop typing indicator
-        ws.send(JSON.stringify({ type: 'chat_typing', typing: false }));
-        
-        // If action required, send to context channel
-        if (response.action) {
-          session.contextWs?.send(JSON.stringify({
-            type: 'action',
-            action: response.type,
-            params: response.params,
-            timestamp: new Date().toISOString()
-          }));
-        }
-        
-        // Send chat response
-        ws.send(JSON.stringify({
-          type: 'chat_message',
-          role: 'assistant',
-          content: response.message,
-          timestamp: new Date().toISOString()
-        }));
-      } else {
-        ws.send(JSON.stringify({
-          type: 'chat_message',
-          role: 'assistant',
-          content: 'I don\'t have access to the UI context yet. Please ensure the page is loaded.',
-          timestamp: new Date().toISOString()
-        }));
-      }
-    }
-  });
-  
-  ws.on('close', () => {
-    console.log(`Chat disconnected: ${applicationId}`);
-    if (session) {
-      session.chatWs = null;
-    }
-  });
-});
-
-async function processWithLLM(userInput, uiContext) {
-  const prompt = `
-    You are controlling a web application via ${typeof userInput === 'string' ? 'chat' : 'voice'}.
-    
-    Current UI Context:
-    ${JSON.stringify(uiContext, null, 2)}
-    
-    User input: "${userInput}"
-    
-    Determine if an action is needed and respond in JSON format:
-    {
-      "action": true/false,
-      "type": "click" | "set_value" | "select_from_dropdown" | "navigate",
-      "params": { "semantic": "element description", "value": "..." },
-      "message": "Response to user (what you did or information about the UI)"
-    }
-    
-    If the user is just asking for information about the UI, set action to false and provide the information in message.
-  `;
-  
-  const response = await openai.chat.completions.create({
-    model: "gpt-4",
-    messages: [{ role: "user", content: prompt }],
-    response_format: { type: "json_object" }
-  });
-  
-  return JSON.parse(response.choices[0].message.content);
-}
-```
-
 ### Production Deployment Considerations
 
 **Security:**
@@ -1481,4 +1286,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.1",
+  "version": "1.0.2",
   "type": "module",
   "description": "Zero-configuration voice and chat control for React applications through autonomous semantic UI discovery",
   "main": "dist/index.js",

package/dist/auuichat.d.ts

@@ -1,57 +0,0 @@
-import * as React from 'react';
-import type { ReactNode } from 'react';
-export interface AIUIConfig {
-    applicationId: string;
-    serverUrl: string;
-    apiKey?: string;
-    pages: MinimalPageConfig[];
-    safetyRules?: SafetyRules;
-    privacy?: PrivacyConfig;
-    onNavigate?: (route: string) => void | Promise<void>;
-}
-export interface MinimalPageConfig {
-    route: string;
-    title?: string;
-    safeActions?: string[];
-    dangerousActions?: string[];
-}
-export interface SafetyRules {
-    requireConfirmation?: string[];
-    blockedSelectors?: string[];
-    allowedDomains?: string[];
-}
-export interface PrivacyConfig {
-    redactPatterns?: string[];
-    exposePasswords?: boolean;
-    exposeCreditCards?: boolean;
-}
-interface AIUIContextValue {
-    config: AIUIConfig;
-    isConnected: boolean;
-    isListening: boolean;
-    currentPage: string | null;
-    connect: () => void;
-    disconnect: () => void;
-    startListening: () => Promise<void>;
-    stopListening: () => void;
-    sendChatMessage: (message: string) => Promise<void>;
-    chatMessages: ChatMessage[];
-    isChatConnected: boolean;
-    executeAction: (action: string, params: any) => Promise<any>;
-    getComponentValue: (selector: string) => any;
-    registerComponent: (componentId: string, element: HTMLElement) => void;
-    unregisterComponent: (componentId: string) => void;
-}
-export interface ChatMessage {
-    role: 'user' | 'assistant';
-    content: string;
-    timestamp: string;
-}
-export declare const useAIUI: () => AIUIContextValue;
-export interface AIUIProviderProps {
-    config: AIUIConfig;
-    children: ReactNode;
-}
-export declare const AIUIProvider: React.FC<AIUIProviderProps>;
-export default AIUIProvider;
-//# sourceMappingURL=auuichat.d.ts.map

package/dist/auuichat.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"auuichat.d.ts","sourceRoot":"","sources":["../src/auuichat.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAOvC,MAAM,WAAW,UAAU;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,iBAAiB,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,WAAW;IACxB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC1B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,UAAU,gBAAgB;IACtB,MAAM,EAAE,UAAU,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,aAAa,EAAE,MAAM,IAAI,CAAC;IAE1B,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IAEzB,aAAa,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7D,iBAAiB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,CAAC;IAC7C,iBAAiB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;IACvE,mBAAmB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACrB;AAID,eAAO,MAAM,OAAO,QAAO,gBAM1B,CAAC;AAu3DF,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,SAAS,CAAC;CACvB;AAED,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CA6RpD,CAAC;AA6BF,eAAe,YAAY,CAAC"}