guideai-app 0.3.0 → 0.3.2

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/event-listner.d.ts

@@ -33,18 +33,31 @@ declare class EventTracker {
     private pendingEvents;
     private currentUrl;
     private organizationKey?;
+    private lastEventTime;
+    private eventThrottleInterval;
+    private lastEventsByType;
+    private duplicateEventBuffer;
+    private maxDuplicateBuffer;
+    private isInitialized;
     private customerMetadata;
     constructor(options?: {
         customerId?: string;
         customerType?: string;
         organizationId?: string;
         organizationKey?: string;
+        batchSize?: number;
+        batchTimeout?: number;
+        eventThrottleInterval?: number;
     });
+    private init;
+    private loadEventsFromStorage;
+    private saveEventsToStorage;
     setCustomerMetadata(metadata: Partial<typeof this.customerMetadata>): void;
     getCustomerMetadata(): typeof this.customerMetadata;
     clearCustomerMetadata(): void;
     initialize(): void;
     private enrichEventData;
+    private sanitizeEventData;
     private getSessionId;
     private getDeviceType;
     startTracking(): void;
@@ -65,6 +78,12 @@ declare class EventTracker {
     private getSafeValue;
     private isFocusable;
     private isFormElement;
+    private generateEventKey;
+    private shouldThrottleEvent;
+    private isDuplicateEvent;
+    private isSignificantClickTarget;
+    private isSignificantFocusTarget;
+    private isSignificantRouteChange;
     private logEvent;
     private startBatchTimer;
     private emitBatch;

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

@@ -6,11 +6,18 @@ declare class UserMetadataTracker {
     private pendingUpdates;
     private isInitialized;
     private onError?;
+    private lastSyncTime;
+    private minSyncInterval;
+    private lastMetadataHash;
+    private pendingUpdateTypes;
     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[];
@@ -21,6 +28,10 @@ declare class UserMetadataTracker {
     private collectBrowserInfo;
     private parseBrowserInfo;
     private startSyncTimer;
+    private shouldSync;
+    private addPendingUpdate;
+    private isDataDuplicate;
+    private generateDataHash;
     private setupEventTrackerIntegration;
     private stopSyncTimer;
     private emitPendingUpdates;

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/dist/utils/constants.d.ts

@@ -2,6 +2,6 @@ export declare const DEFAULT_PROMPT = "you are Guide AI.\n      Your role is to
 export declare const IGNORE_MESSAGE_TYPES: string[];
 export declare const GUIDE_AI_API_BASE = "https://www.getguide.ai/api";
 export declare const OPENAI_REALTIME_BASE = "https://api.openai.com/v1/realtime";
-export declare const OPENAI_REALTIME_MODEL = "gpt-4o-realtime-preview-2024-12-17";
+export declare const OPENAI_REALTIME_MODEL = "gpt-realtime-2025-08-28";
 export declare const GEMINI_API_KEY = "AIzaSyBiFyzjYVupLyk8BdmfWzBL1GbzX8OUdPc";
 export declare const GEMINI_API_ENDPOINT = "https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent";

package/package.json

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

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;
-}