guideai-app 0.3.1 → 0.3.4

package/visit-tracking-usage.md

@@ -0,0 +1,134 @@
+# GuideAI Visit Tracking Usage
+
+## Overview
+
+The GuideAI component now includes an improved visit tracking system that prevents continuous API calls and only tracks visits once per session.
+
+## How It Works
+
+### Automatic Visit Tracking
+- **Session-based**: Visit tracking only occurs once per browser session
+- **No continuous API calls**: The system prevents multiple visit tracking calls
+- **Automatic initialization**: Visit tracking happens automatically when the component loads
+
+### Manual Visit Tracking for Login Events
+
+When a user logs in to your application, you can manually trigger visit tracking:
+
+```javascript
+// Reset session tracking and manually track a visit
+window.GuideAI.metadata.resetSessionVisitTracking();
+window.GuideAI.metadata.trackVisitManually();
+```
+
+## API Methods
+
+### `window.GuideAI.metadata.resetSessionVisitTracking()`
+Resets the session visit tracking flag, allowing a new visit to be tracked.
+
+### `window.GuideAI.metadata.trackVisitManually()`
+Manually tracks a visit and increments the visit count. This is useful for login events.
+
+### `window.GuideAI.metadata.trackLogin(additionalInfo?)`
+Tracks a login event with optional additional user information.
+
+## Usage Examples
+
+### Basic Login Integration
+
+```javascript
+// When user successfully logs in
+function onUserLogin(userData) {
+  // Reset session tracking to allow new visit tracking
+  window.GuideAI.metadata.resetSessionVisitTracking();
+  
+  // Manually track the visit
+  window.GuideAI.metadata.trackVisitManually();
+  
+  // Track the login event
+  window.GuideAI.metadata.trackLogin({
+    userId: userData.id,
+    userEmail: userData.email,
+    userRole: userData.role
+  });
+}
+```
+
+### React Component Integration
+
+```jsx
+import { useEffect } from 'react';
+
+function LoginComponent() {
+  const handleLogin = async (credentials) => {
+    try {
+      const userData = await loginUser(credentials);
+      
+      // Track visit and login after successful authentication
+      if (window.GuideAI?.metadata) {
+        window.GuideAI.metadata.resetSessionVisitTracking();
+        window.GuideAI.metadata.trackVisitManually();
+        window.GuideAI.metadata.trackLogin({
+          userId: userData.id,
+          userEmail: userData.email
+        });
+      }
+      
+      // Navigate to dashboard
+      router.push('/dashboard');
+    } catch (error) {
+      console.error('Login failed:', error);
+    }
+  };
+
+  return (
+    <form onSubmit={handleLogin}>
+      {/* Login form */}
+    </form>
+  );
+}
+```
+
+## Configuration
+
+You can configure visit tracking behavior in the GuideAI component props:
+
+```jsx
+<GuideAI
+  organizationKey="your-org-key"
+  metadata={{
+    config: {
+      trackVisits: true,        // Enable/disable visit tracking
+      trackLogins: true,        // Enable/disable login tracking
+      syncInterval: 30000,      // Sync interval in milliseconds
+      collectBrowserInfo: true, // Collect browser information
+      collectUserAgent: true    // Collect user agent string
+    }
+  }}
+/>
+```
+
+## Benefits
+
+1. **Reduced API calls**: Visit tracking only happens once per session
+2. **Accurate analytics**: Proper visit counting without duplicates
+3. **Login integration**: Manual tracking for login events
+4. **Session management**: Automatic session-based tracking
+5. **Performance**: No continuous background API calls
+
+## Troubleshooting
+
+### Visit tracking not working
+- Ensure `trackVisits: true` is set in the metadata config
+- Check browser console for any errors
+- Verify the GuideAI component is properly initialized
+
+### Multiple API calls still occurring
+- Check if the component is being re-mounted multiple times
+- Ensure you're not calling `trackVisitManually()` repeatedly
+- Verify session storage is working in your browser
+
+### Login tracking not working
+- Ensure `trackLogins: true` is set in the metadata config
+- Call `resetSessionVisitTracking()` before `trackVisitManually()`
+- Check that the user is properly authenticated before tracking

package/components/Styles.d.ts

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

package/types/index.d.ts

@@ -1,24 +0,0 @@
-export interface ConversationItem {
-    event_id?: string;
-    type: string;
-    previous_item_id: string | null;
-    item: Record<string, any>;
-    timestamp: number;
-}
-export type RecordingStatus = 'idle' | 'recording' | 'processing' | 'playing' | 'initializing';
-export interface GuideAIProps {
-    apiKey?: string;
-    organizationKey: string;
-    position?: {
-        top?: string;
-        right?: string;
-        bottom?: string;
-        left?: string;
-        marginTop?: string;
-        marginRight?: string;
-        marginBottom?: string;
-        marginLeft?: string;
-        transform?: string;
-    };
-    onError?: (error: string | Error, context?: string) => void;
-}