guideai-app 0.1.9 → 0.2.1

package/dist/hooks/useRecording.d.ts

@@ -2,7 +2,9 @@ import { RecordingStatus } from '../types';
 export declare const useRecording: (organizationKey: string, onError: (error: string | Error, context?: string) => void, logMessageFn: (message: string, sender: "GUIDEAI" | "HUMAN") => Promise<void>, addConversationHistoryFn: (sendMessageFn: (message: any) => void) => void, storeConversationItemFn: (item: any) => void, updateConversationItem: (itemId: string, updateData: Partial<any>) => void, isAddingHistoryContextRef: React.MutableRefObject<boolean>) => {
     status: RecordingStatus;
     isSessionReady: boolean;
+    isConversationActive: boolean;
     toggleRecording: () => Promise<void>;
+    toggleConversation: () => Promise<void>;
     cleanupWebRTC: () => void;
     audioElementRef: import("react").MutableRefObject<HTMLAudioElement | null>;
     ephemeralToken: string | null;

package/obfuscate.js

@@ -0,0 +1,40 @@
+const fs = require('fs');
+const path = require('path');
+const JavaScriptObfuscator = require('javascript-obfuscator');
+
+// Files to obfuscate
+const files = [
+  'dist/index.js',
+  'dist/index.esm.js'
+];
+
+// Load obfuscator config
+const config = JSON.parse(fs.readFileSync(path.resolve(__dirname, 'obfuscator.json'), 'utf8'));
+
+// Process each file
+
+files.forEach(file => {
+  const filePath = path.resolve(__dirname, file);
+  
+  try {
+    // Check if file exists
+    if (!fs.existsSync(filePath)) {
+      console.warn(`Warning: ${file} does not exist, skipping obfuscation.`);
+      return;
+    }
+    
+    
+    // Read the file
+    const code = fs.readFileSync(filePath, 'utf8');
+    
+    // Obfuscate the code
+    const obfuscationResult = JavaScriptObfuscator.obfuscate(code, config);
+    
+    // Write the obfuscated code back to the file
+    fs.writeFileSync(filePath, obfuscationResult.getObfuscatedCode());
+    
+  } catch (error) {
+    console.error(`Error obfuscating ${file}:`, error);
+    process.exit(1);
+  }
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guideai-app",
-  "version": "0.1.9",
+  "version": "0.2.1",
   "description": "AI-powered guide component for React applications",
   "main": "dist/GuideAI.js",
   "types": "dist/GuideAI.d.ts",

package/rollup.config.js

@@ -0,0 +1,34 @@
+import commonjs from '@rollup/plugin-commonjs';
+import resolve from '@rollup/plugin-node-resolve';
+import typescript from '@rollup/plugin-typescript';
+import { terser } from 'rollup-plugin-terser';
+import peerDepsExternal from 'rollup-plugin-peer-deps-external';
+
+export default {
+  input: 'src/index.ts',
+  output: [
+    {
+      file: 'dist/index.js',
+      format: 'cjs',
+      sourcemap: true,
+      exports: 'named'
+    },
+    {
+      file: 'dist/index.esm.js',
+      format: 'esm',
+      sourcemap: true,
+      exports: 'named'
+    },
+  ],
+  plugins: [
+    peerDepsExternal(),
+    resolve(),
+    commonjs(),
+    typescript({
+      tsconfig: './tsconfig.json',
+      exclude: ['**/__tests__/**'],
+    }),
+    terser(),
+  ],
+  external: ['react', 'react-dom', 'openai'],
+}; 

package/structure.md

@@ -0,0 +1,128 @@
+# GuideAI Package Structure
+
+## Directory Structure
+
+```
+guide-ai-package/src/
+├── GuideAI.tsx                 # Main component
+├── index.ts                    # Package entry point
+├── components/                 # React components
+│   └── Styles.tsx              # Styling for the component
+├── hooks/                      # React hooks
+│   ├── useConversation.ts      # Conversation management
+│   └── useRecording.ts         # Audio recording and WebRTC
+├── types/                      # TypeScript type definitions
+│   └── index.ts                # Type definitions
+└── utils/                      # Utility functions
+    ├── api-services.ts         # API related functions
+    ├── dom-interaction.ts      # DOM manipulation utilities
+    ├── react-hooks.ts          # React hooks utilities
+    ├── storage.ts              # Local storage utilities
+    └── webrtc.ts               # WebRTC related utilities
+```
+
+## File Descriptions
+
+### Main Files
+
+#### `GuideAI.tsx`
+The main component exported by the package that provides the user interface for audio interactions.
+
+**Functions & Components:**
+- `GuideAI(props: GuideAIProps)`: Main component that renders the UI
+  - Sets up conversation management
+  - Initializes audio recording
+  - Handles user interactions
+
+#### `index.ts`
+Entry point for the package, exports the GuideAI component and types.
+
+**Exports:**
+- `GuideAI`
+- `GuideAIProps` (type)
+
+### Components
+
+#### `components/Styles.tsx`
+Contains the CSS styling for the GuideAI component.
+
+**Functions & Components:**
+- `Styles()`: Component that injects CSS styles into the page
+
+### Hooks
+
+#### `hooks/useConversation.ts`
+Custom hook for managing conversation state and interaction with the API.
+
+**Functions:**
+- `useConversation(organizationKey, onError)`: Main hook function
+  - `storeConversationItem(item)`: Stores a conversation item
+  - `initializeConversation()`: Creates or restores a conversation
+  - `logMessageToConversation(content, sender)`: Logs a message to the conversation
+  - `addConversationHistory(sendMessageFn)`: Adds conversation history to a new session
+  - `isConversationStale()`: Checks if conversation is more than 15 minutes old
+
+#### `hooks/useRecording.ts`
+Custom hook for managing audio recording, WebRTC connections, and handling responses.
+
+**Functions:**
+- `useRecording(organizationKey, onError, logMessageFn, addConversationHistoryFn, storeConversationItemFn, isAddingHistoryContextRef)`: Main hook function
+  - `sendWebRTCMessage(message)`: Sends a message through WebRTC
+  - `cleanupWebRTC()`: Cleans up WebRTC connections and media streams
+  - `handleWebRTCMessage(message)`: Handles incoming WebRTC messages
+  - `startRecording()`: Starts audio recording
+  - `stopRecording()`: Stops audio recording
+  - `toggleRecording()`: Toggles recording state
+
+### Types
+
+#### `types/index.ts`
+Contains TypeScript type definitions used throughout the package.
+
+**Types:**
+- `ConversationItem`: Represents an item in the conversation
+- `RecordingStatus`: Status of the recording ('idle' | 'recording' | 'processing' | 'playing' | 'initializing')
+- `GuideAIProps`: Props for the GuideAI component
+
+### Utils
+
+#### `utils/api-services.ts`
+Functions for interacting with external APIs.
+
+**Functions:**
+- `createNewConversation(organizationKey)`: Creates a new conversation
+- `logMessage(conversationId, content, sender)`: Logs a message to the conversation
+- `fetchEphemeralToken(organizationKey)`: Fetches an ephemeral token for WebRTC
+- `geminiFlash(prompt)`: Makes a call to the Gemini API
+
+#### `utils/dom-interaction.ts`
+Utilities for interacting with the DOM.
+
+**Functions:**
+- `highlightElement(selector, logMessageFn)`: Highlights an element on the page
+- DOM traversal and interaction functions
+
+#### `utils/react-hooks.ts`
+Utilities for React hooks to avoid duplicate React instances.
+
+**Functions:**
+- `getReactHooks()`: Returns React hooks from the host application or fall back to local ones
+
+#### `utils/storage.ts`
+Local storage utility functions.
+
+**Constants:**
+- `STORAGE_PREFIX`: Prefix for storage keys
+- `STORAGE_KEYS`: Object containing all storage keys
+
+**Functions:**
+- `saveToStorage(key, value)`: Saves a value to localStorage
+- `getFromStorage(key, defaultValue)`: Gets a value from localStorage
+
+#### `utils/webrtc.ts`
+WebRTC related utilities for audio streaming.
+
+**Functions:**
+- `initializeWebRTC(audioStream, token, audioElementRef, peerConnectionRef, dataChannelRef, handleMessageCallback)`: Sets up WebRTC connection
+- `sendMessage(dataChannel, message)`: Sends a message through the data channel
+- `orderConversationItems(items)`: Orders conversation items for replay