guideai-app 0.2.0 → 0.2.2

package/dist/messageStorageUtils.d.ts

@@ -0,0 +1,26 @@
+export interface StoredMessage {
+    content: string;
+    sender: 'GUIDEAI' | 'HUMAN';
+    timestamp: number;
+}
+export interface StoredConversation {
+    conversationId: string;
+    messages: StoredMessage[];
+    timestamp: number;
+    organizationKey: string;
+}
+export declare const CONVERSATION_STORAGE_KEY = "guideai_conversation";
+export declare const CONVERSATION_EXPIRY_MINUTES = 30;
+export declare const MAX_STORED_MESSAGES = 50;
+export declare const isLocalStorageAvailable: () => boolean;
+export declare const isConversationExpired: (conversation: StoredConversation) => boolean;
+export declare const saveConversationToStorage: (conversation: StoredConversation) => void;
+export declare const loadConversationFromStorage: () => StoredConversation | null;
+export declare const clearConversationStorage: () => void;
+export declare const addMessageToStorage: (message: StoredMessage, conversationId: string, organizationKey: string) => void;
+export declare const checkForStoredConversation: (currentOrganizationKey: string) => {
+    shouldRestore: boolean;
+    conversationId: string | null;
+    messages: StoredMessage[] | null;
+};
+export declare const formatConversationContext: (messages: StoredMessage[], maxMessages?: number) => string;

package/dist/utils/storage.d.ts

@@ -4,6 +4,11 @@ export declare const STORAGE_KEYS: {
     CONVERSATION_ID: string;
     HAS_INTERACTED: string;
     LAST_ACTIVITY: string;
+    MIC_PERMISSION_GRANTED: string;
+    CONVERSATION_ACTIVE: string;
+    EPHEMERAL_TOKEN: string;
+    TOKEN_TIMESTAMP: string;
 };
 export declare const saveToStorage: (key: string, value: any) => void;
 export declare const getFromStorage: <T>(key: string, defaultValue: T) => T;
+export declare const isTokenValid: () => boolean;

package/hooks/useConversation.d.ts

@@ -0,0 +1,11 @@
+import { ConversationItem } from '../types';
+export declare const useConversation: (organizationKey: string, onError: (error: string | Error, context?: string) => void) => {
+    conversationItems: ConversationItem[];
+    conversationIdRef: import("react").MutableRefObject<string | null>;
+    storeConversationItem: (eventData: any) => void;
+    updateConversationItem: (itemId: string, updateData: Partial<any>) => void;
+    logMessageToConversation: (content: string, sender: "GUIDEAI" | "HUMAN") => Promise<void>;
+    addConversationHistory: (sendMessageFn: (message: any) => void) => void;
+    isAddingHistoryContext: import("react").MutableRefObject<boolean>;
+    hasCreatedConversationRef: import("react").MutableRefObject<boolean>;
+};

package/hooks/useRecording.d.ts

@@ -0,0 +1,12 @@
+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;
+    setEphemeralToken: import("react").Dispatch<import("react").SetStateAction<string | null>>;
+};

package/index.d.ts

@@ -0,0 +1,3 @@
+import GuideAI from './GuideAI';
+export default GuideAI;
+export type { GuideAIProps } from './GuideAI';

package/package.json

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

package/types/index.d.ts

@@ -0,0 +1,20 @@
+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;
+        marginLeft?: string;
+    };
+    onError?: (error: string | Error, context?: string) => void;
+}

package/utils/api-services.d.ts

@@ -0,0 +1,5 @@
+export declare const DEFAULT_PROMPT = "you are Guide AI.\n      Your role is to answer any question directly and succinctly that a user has. NEVER DIRECTLY MENTION THE SCREENSHOT, but use its information as much as possible to target your responses.\n      If nothing is asked, then your goal is to generally assist them.\n      IMPORTANT: NEVER answer in more than 10 words. Always be concise and limit answers to 1 sentence maximum. Be simple and as short as possible.\n      Your job is to help them get it done through asking more and more targeted specific questions.";
+export declare const geminiFlash: (prompt: string) => Promise<any>;
+export declare const createNewConversation: (organizationKey: string) => Promise<string | null>;
+export declare const logMessage: (conversationId: string, content: string, sender: "GUIDEAI" | "HUMAN") => Promise<void>;
+export declare const fetchEphemeralToken: (organizationKey: string) => Promise<string | null>;

package/utils/dom-interaction.d.ts

@@ -0,0 +1,2 @@
+export declare const clickElement: (element: Element, rect: DOMRect) => Promise<void>;
+export declare const highlightElement: (selector: string | string[], logMessageFn?: (message: string, sender: "GUIDEAI" | "HUMAN") => void) => Promise<boolean>;

package/utils/react-hooks.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+export type UseStateHook = typeof React.useState;
+export type UseEffectHook = typeof React.useEffect;
+export type UseRefHook = typeof React.useRef;
+export declare const getReactHooks: () => {
+    useState: UseStateHook;
+    useEffect: UseEffectHook;
+    useRef: UseRefHook;
+};

package/utils/storage.d.ts

@@ -0,0 +1,14 @@
+export declare const STORAGE_PREFIX = "guideAI_";
+export declare const STORAGE_KEYS: {
+    CONVERSATION_ITEMS: string;
+    CONVERSATION_ID: string;
+    HAS_INTERACTED: string;
+    LAST_ACTIVITY: string;
+    MIC_PERMISSION_GRANTED: string;
+    CONVERSATION_ACTIVE: string;
+    EPHEMERAL_TOKEN: string;
+    TOKEN_TIMESTAMP: string;
+};
+export declare const saveToStorage: (key: string, value: any) => void;
+export declare const getFromStorage: <T>(key: string, defaultValue: T) => T;
+export declare const isTokenValid: () => boolean;

package/utils/webrtc.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+export declare const initializeWebRTC: (audioStream: MediaStream, token: string, audioElementRef: React.RefObject<HTMLAudioElement>, peerConnectionRef: React.MutableRefObject<RTCPeerConnection | null>, dataChannelRef: React.MutableRefObject<RTCDataChannel | null>, onMessage: (message: any) => void, onOpen?: () => void) => Promise<boolean>;
+export declare const sendMessage: (dataChannel: RTCDataChannel | null, message: any) => boolean;