guideai-app 0.3.0 → 0.3.3

package/dist/components/TranscriptBox.d.ts

@@ -13,5 +13,5 @@ interface TranscriptBoxProps {
     onTextKeyPress?: (event: React.KeyboardEvent) => void;
     textPlaceholder?: string;
 }
-declare const TranscriptBox: React.FC<TranscriptBoxProps>;
+declare const TranscriptBox: React.NamedExoticComponent<TranscriptBoxProps>;
 export default TranscriptBox;

package/dist/metric/metadata-tracker.d.ts

@@ -7,10 +7,13 @@ declare class UserMetadataTracker {
     private isInitialized;
     private onError?;
     constructor(organizationKey: string, config?: MetadataConfig, onError?: (error: Error, context: string) => void);
-    private init;
+    init(): void;
     updateUserInfo(userInfo: Partial<UserMetadata>): void;
     trackLogin(additionalInfo?: Partial<UserMetadata>): void;
+    private trackVisitOncePerSession;
     trackVisit(): void;
+    resetSessionVisitTracking(): void;
+    trackVisitManually(): void;
     trackCustomEvent(eventType: string, customData: Record<string, any>): void;
     getMetadata(): UserMetadata;
     getPendingUpdates(): MetadataUpdate[];

package/dist/utils/api.d.ts

@@ -1,4 +1,4 @@
-import { UserMetadata, MetadataUpdate } from '../types/metadata.types';
+import { MetadataUpdate } from '../types/metadata.types';
 interface ConversationData {
     id: string;
     ephemeralToken: string;
@@ -6,7 +6,5 @@ interface ConversationData {
 }
 export declare const createNewConversation: (organizationKey: string, onError: (error: Error, context: string) => void) => Promise<ConversationData | null>;
 export declare const logMessage: (content: string, sender: "GUIDEAI" | "HUMAN", conversationId: string | null, organizationKey: string, onError: (error: Error, context: string) => void) => Promise<void>;
-export declare const sendUserMetadata: (metadata: UserMetadata, organizationKey: string, onError: (error: Error, context: string) => void) => Promise<boolean>;
 export declare const sendMetadataUpdates: (updates: MetadataUpdate[], organizationKey: string, onError: (error: Error, context: string) => void) => Promise<boolean>;
-export declare const updateUserMetadata: (userId: string, metadataUpdate: Partial<UserMetadata>, organizationKey: string, onError: (error: Error, context: string) => void) => Promise<boolean>;
 export {};

package/package.json

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

package/components/Styles.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const Styles: React.FC;
-export default Styles;

package/metadata-tracking-example.md

@@ -1,324 +0,0 @@
-# User Metadata Tracking - Implementation Guide
-
-## Overview
-
-The GuideAI package now includes comprehensive user metadata tracking capabilities designed for integration with Overproof. This system tracks the following metadata:
-
-- **User's First Visit** - Timestamp of the first time the user interacted with GuideAI
-- **User's Last Visit** - Timestamp of the most recent user interaction
-- **User Logins** - Count and timestamp of login events
-- **User Type** - Classification of the user (agent, admin, manager, customer, guest, etc.)
-- **Customer Type** - Type of customer (individual, business, enterprise, etc.)
-- **Customer License** - License identifier for the customer
-
-## Basic Usage
-
-### 1. Basic Integration
-
-```typescript
-import { GuideAI } from 'guide-ai-package';
-
-function App() {
-  return (
-    <GuideAI 
-      organizationKey="your-org-key"
-      metadata={{
-        config: {
-          trackVisits: true,
-          trackLogins: true,
-          syncInterval: 30000, // Sync every 30 seconds
-          storage: 'localStorage'
-        },
-        initialUserData: {
-          userType: 'agent',
-          customerType: 'business',
-          customerLicense: 'OVERPRF-12345'
-        },
-        onMetadataUpdate: (metadata) => {
-          console.log('Metadata updated:', metadata);
-          // Send to your analytics system
-        }
-      }}
-    />
-  );
-}
-```
-
-### 2. Tracking User Login Events
-
-```typescript
-import { useRef } from 'react';
-
-function LoginComponent() {
-  const guideAIRef = useRef();
-
-  const handleLogin = async (userInfo) => {
-    // Your login logic here
-    const loginResult = await performLogin(userInfo);
-    
-    if (loginResult.success) {
-      // Track the login with GuideAI
-      guideAIRef.current?.trackLogin({
-        userId: loginResult.userId,
-        userType: loginResult.userType,
-        customerType: loginResult.customerType,
-        customerLicense: loginResult.license
-      });
-    }
-  };
-
-  return (
-    <div>
-      <GuideAI 
-        ref={guideAIRef}
-        organizationKey="your-org-key"
-        metadata={{
-          config: { trackLogins: true }
-        }}
-      />
-      <button onClick={handleLogin}>Login</button>
-    </div>
-  );
-}
-```
-
-### 3. Updating User Information
-
-```typescript
-function UserProfileComponent() {
-  const guideAIRef = useRef();
-
-  const updateUserProfile = (newUserData) => {
-    // Update user profile in your system
-    saveUserProfile(newUserData);
-    
-    // Update GuideAI metadata
-    guideAIRef.current?.updateUserInfo({
-      userType: newUserData.role,
-      customerType: newUserData.accountType,
-      customerLicense: newUserData.license,
-      customFields: {
-        department: newUserData.department,
-        region: newUserData.region
-      }
-    });
-  };
-
-  return (
-    <GuideAI 
-      ref={guideAIRef}
-      organizationKey="your-org-key"
-      metadata={{
-        config: {
-          customFields: ['department', 'region'],
-          collectBrowserInfo: true
-        }
-      }}
-    />
-  );
-}
-```
-
-## Configuration Options
-
-### MetadataConfig
-
-```typescript
-interface MetadataConfig {
-  // Whether to automatically track visits (default: true)
-  trackVisits?: boolean;
-  
-  // Whether to automatically track logins (default: true)
-  trackLogins?: boolean;
-  
-  // How often to sync metadata to backend in milliseconds (default: 30000)
-  syncInterval?: number;
-  
-  // Storage strategy (default: 'localStorage')
-  storage?: 'localStorage' | 'sessionStorage' | 'memory';
-  
-  // Custom metadata fields to collect
-  customFields?: string[];
-  
-  // Whether to collect browser information (default: true)
-  collectBrowserInfo?: boolean;
-  
-  // Whether to collect user agent (default: true)
-  collectUserAgent?: boolean;
-}
-```
-
-### UserMetadata Structure
-
-```typescript
-interface UserMetadata {
-  // Core identification
-  userId?: string;
-  userType?: 'agent' | 'admin' | 'manager' | 'customer' | 'guest' | string;
-  
-  // Customer-specific metadata
-  customerType?: 'individual' | 'business' | 'enterprise' | string;
-  customerLicense?: string;
-  
-  // Visit tracking (automatically managed)
-  firstVisit?: number; // timestamp
-  lastVisit?: number; // timestamp
-  visitCount?: number;
-  
-  // Login tracking (requires manual tracking)
-  loginCount?: number;
-  lastLogin?: number; // timestamp
-  
-  // Session metadata (automatically managed)
-  organizationKey: string;
-  sessionId?: string;
-  
-  // Browser information (automatically collected if enabled)
-  userAgent?: string;
-  browserInfo?: {
-    name?: string;
-    version?: string;
-    platform?: string;
-  };
-  
-  // Custom fields for Overproof-specific needs
-  customFields?: Record<string, string | number | boolean>;
-}
-```
-
-## API Integration
-
-The system automatically sends metadata updates to these endpoints:
-
-### POST `/user-metadata`
-Sends complete user metadata object when initially collected.
-
-### POST `/metadata-updates` 
-Sends batched metadata updates periodically.
-
-### PATCH `/users/{userId}/metadata`
-Updates specific user metadata when userId is available.
-
-## Backend Implementation
-
-You'll need to implement these endpoints in your backend:
-
-```typescript
-// Example Express.js implementation
-app.post('/api/user-metadata', (req, res) => {
-  const { organizationKey, metadata, timestamp } = req.body;
-  
-  // Store metadata in your database
-  await UserMetadata.upsert({
-    organizationKey,
-    userId: metadata.userId || 'anonymous',
-    ...metadata,
-    lastUpdated: new Date(timestamp)
-  });
-  
-  res.json({ success: true });
-});
-
-app.post('/api/metadata-updates', (req, res) => {
-  const { organizationKey, updates, batchTimestamp } = req.body;
-  
-  // Process batch updates
-  for (const update of updates) {
-    await processMetadataUpdate(organizationKey, update);
-  }
-  
-  res.json({ success: true });
-});
-```
-
-## Privacy Considerations
-
-- **User Agent Collection**: Can be disabled via `collectUserAgent: false`
-- **Browser Info Collection**: Can be disabled via `collectBrowserInfo: false`
-- **Custom Fields**: Only fields specified in `customFields` array are collected
-- **Storage**: Can be set to `'memory'` for session-only storage without persistence
-
-## Testing
-
-```typescript
-// Get current metadata
-const metadata = guideAIRef.current?.getMetadata();
-console.log('Current metadata:', metadata);
-
-// Force sync metadata now
-await guideAIRef.current?.syncMetadata();
-
-// Track custom events
-guideAIRef.current?.trackCustomEvent('document_viewed', {
-  documentType: 'policy',
-  documentId: 'POL-12345'
-});
-```
-
-## Overproof Integration Example
-
-```typescript
-function OverproofApp() {
-  const guideAIRef = useRef();
-
-  // Track when user logs into Overproof
-  const handleOverproofLogin = (user) => {
-    guideAIRef.current?.trackLogin({
-      userId: user.id,
-      userType: user.role, // 'agent', 'admin', etc.
-      customerType: user.accountType,
-      customerLicense: user.licenseNumber,
-      customFields: {
-        agencyId: user.agencyId,
-        territory: user.territory,
-        permissions: user.permissions.join(',')
-      }
-    });
-  };
-
-  // Track when user profile is updated
-  const handleProfileUpdate = (updatedProfile) => {
-    guideAIRef.current?.updateUserInfo({
-      userType: updatedProfile.role,
-      customerLicense: updatedProfile.licenseNumber,
-      customFields: {
-        agencyId: updatedProfile.agencyId,
-        territory: updatedProfile.territory
-      }
-    });
-  };
-
-  return (
-    <GuideAI 
-      ref={guideAIRef}
-      organizationKey="overproof-org-key"
-      metadata={{
-        config: {
-          trackVisits: true,
-          trackLogins: true,
-          syncInterval: 15000, // More frequent syncing for Overproof
-          customFields: ['agencyId', 'territory', 'permissions'],
-          collectBrowserInfo: true
-        },
-        onMetadataUpdate: (metadata) => {
-          // Send to Overproof analytics
-          window.OverproofAnalytics?.track('guideai_metadata_update', metadata);
-        }
-      }}
-    />
-  );
-}
-```
-
-## Storage and Data Persistence
-
-- **localStorage**: Persists across browser sessions (default)
-- **sessionStorage**: Persists only for current session
-- **memory**: No persistence, data lost on page refresh
-
-Metadata is automatically:
-- Saved locally based on storage configuration
-- Synced to backend at configured intervals
-- Restored when user returns (if using persistent storage)
-
-This implementation provides a robust foundation for tracking user metadata in the Overproof environment while maintaining flexibility for other use cases.

package/obfuscate.js

@@ -1,40 +0,0 @@
-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/obfuscator.prod.json

@@ -1,24 +0,0 @@
-{
-  "compact": true,
-  "controlFlowFlattening": false,
-  "controlFlowFlatteningThreshold": 0.75,
-  "deadCodeInjection": false,
-  "deadCodeInjectionThreshold": 0.4,
-  "debugProtection": false,
-  "debugProtectionInterval": 0,
-  "disableConsoleOutput": true,
-  "identifierNamesGenerator": "hexadecimal",
-  "log": false,
-  "numbersToExpressions": false,
-  "renameGlobals": false,
-  "rotateStringArray": false,
-  "selfDefending": false,
-  "shuffleStringArray": false,
-  "splitStrings": false,
-  "splitStringsChunkLength": 10,
-  "stringArray": false,
-  "stringArrayEncoding": [],
-  "stringArrayThreshold": 0,
-  "transformObjectKeys": false,
-  "unicodeEscapeSequence": false
-} 

package/structure.md

@@ -1,128 +0,0 @@
-# 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