@solveo-ai/react-native 0.1.0 → 0.1.2

package/README.md

@@ -2,6 +2,8 @@
 
 React Native SDK for the Solveo AI platform. Build AI-powered chat experiences in your mobile apps.
 
+**Supports both React Native CLI and Expo projects.**
+
 ## Installation
 
 ```bash
@@ -10,6 +12,57 @@ npm install @solveo-ai/react-native @solveo-ai/sdk-core
 yarn add @solveo-ai/react-native @solveo-ai/sdk-core
 ```
 
+### React Native CLI Setup
+
+For projects created with `react-native init` or Expo Dev Clients:
+
+```bash
+# Install Firebase for push notifications
+npm install @react-native-firebase/app @react-native-firebase/messaging
+
+# Install AsyncStorage (already bundled with this SDK)
+npm install @react-native-async-storage/async-storage
+```
+
+**Firebase Configuration:**
+
+1. **Android:**
+   - Download `google-services.json` from Firebase Console
+   - Place it in `android/app/`
+   - Add the Google Services plugin to `android/app/build.gradle`:
+     ```gradle
+     apply plugin: 'com.google.gms.google-services'
+     ```
+   - Add classpath to `android/build.gradle`:
+     ```gradle
+     classpath 'com.google.gms:google-services:4.3.15'
+     ```
+
+2. **iOS:**
+   - Download `GoogleService-Info.plist` from Firebase Console
+   - Place it in your Xcode project
+   - Enable "Push Notifications" capability in Xcode
+   - Add to `ios/YourProject/AppDelegate.m`:
+     ```objc
+     #import <Firebase.h>
+     - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+       [FIRApp configure];
+       [UNUserNotificationCenter currentNotificationCenter].delegate = self;
+       [application registerForRemoteNotifications];
+       return YES;
+     }
+     ```
+
+### Expo Setup
+
+For Expo projects (including Expo Go):
+
+```bash
+npx expo install expo-notifications
+```
+
+**Note:** For push notifications in production, you'll need to configure [Expo Application Services (EAS)](https://docs.expo.dev/push-notifications/overview/).
+
 ## Quick Start
 
 ```tsx
@@ -47,6 +100,69 @@ function ChatScreen() {
 }
 ```
 
+## Push Notifications
+
+The SDK automatically detects which push notification system is available and uses the appropriate one.
+
+### Setup for React Native CLI
+
+Follow the Firebase configuration steps above, then use the `usePushNotifications` hook:
+
+```tsx
+import { usePushNotifications } from '@solveo-ai/react-native';
+
+function ChatScreen() {
+  const { registerDevice } = usePushNotifications({
+    mode: 'widget',
+    conversationId: 'your-conversation-id',
+    autoRegister: true,
+  });
+
+  // Device will automatically register when permission is granted
+}
+```
+
+### Setup for Expo
+
+```tsx
+import { usePushNotifications } from '@solveo-ai/react-native';
+
+function ChatScreen() {
+  const { requestPermission, registerDevice } = usePushNotifications({
+    mode: 'widget',
+    conversationId: 'your-conversation-id',
+  });
+
+  useEffect(() => {
+    requestPermission().then(granted => {
+      if (granted) {
+        registerDevice();
+      }
+    });
+  }, [requestPermission, registerDevice]);
+}
+```
+
+## Development
+
+From the repo root (monorepo), install and build:
+
+```bash
+# From platform root
+npm install
+npm run build --workspace=@solveo-ai/react-native
+```
+
+Or from this package:
+
+```bash
+cd sdks/react-native
+npm install
+npm run build
+```
+
+This produces `dist/index.js`, `dist/index.mjs`, and `dist/index.d.ts`. Type declarations are included; `prepublishOnly` runs the build before publishing so published packages include `dist` and types.
+
 ## Documentation
 
 See [full documentation](https://docs.solveoai.io/sdk/react-native).

package/dist/index.d.mts

@@ -0,0 +1,199 @@
+import React, { ReactNode } from 'react';
+import { SolveoClientConfig, SolveoSDK, Socket, CustomerSocketManager, AgentSocketManager, StreamingSocket, Conversation, Message, HumanAgent, Widget, WidgetConfig, Device, MessageAttachment, Agent, AgentCreateRequest, AgentUpdateRequest, ConversationMetrics, SentimentDistribution, FeedbackStats, TokenUsageMetrics } from '@solveo-ai/sdk-core';
+export { Agent, Conversation, ConversationStatus, FeedbackType, Message, MessageAttachment, SentimentType, Widget } from '@solveo-ai/sdk-core';
+
+interface SolveoContextValue {
+    sdk: SolveoSDK;
+    config: SolveoProviderConfig;
+    customerSocket: Socket | null;
+    customerSocketManager: CustomerSocketManager | null;
+    agentSocket: Socket | null;
+    agentSocketManager: AgentSocketManager | null;
+    streamingSocket: StreamingSocket | null;
+    connectCustomerSocket: (conversationId: string) => void;
+    disconnectCustomerSocket: () => void;
+    connectAgentSocket: (token: string) => void;
+    disconnectAgentSocket: () => void;
+    connectStreamingSocket: (conversationId: string) => void;
+    disconnectStreamingSocket: () => void;
+}
+interface SolveoProviderConfig extends Omit<SolveoClientConfig, 'platform'> {
+    user?: {
+        email?: string;
+        name?: string;
+        id?: string;
+    };
+    autoConnectCustomer?: boolean;
+    autoConnectAgent?: boolean;
+    conversationId?: string;
+    onError?: (error: Error) => void;
+}
+interface SolveoProviderProps {
+    children: ReactNode;
+    config: SolveoProviderConfig;
+}
+declare function SolveoProvider({ children, config }: SolveoProviderProps): React.JSX.Element;
+declare function useSolveo(): SolveoContextValue;
+
+interface UseChatOptions {
+    widgetId?: string;
+    agentId?: string;
+    persistConversation?: boolean;
+}
+declare function useChat(options?: UseChatOptions): {
+    conversation: Conversation | null;
+    messages: Message[];
+    isLoading: boolean;
+    isStreaming: boolean;
+    streamingContent: string;
+    error: Error | null;
+    createConversation: () => Promise<Conversation>;
+    sendMessage: (content: string) => Promise<void>;
+    loadMessages: (conversationId: string) => Promise<void>;
+    submitFeedback: (messageId: string, rating: "THUMBS_UP" | "THUMBS_DOWN") => Promise<void>;
+};
+
+declare function useRealtime(): {
+    isConnected: boolean;
+    agentTyping: boolean;
+    queuePosition: number | null;
+    estimatedWait: number | null;
+};
+
+declare function useEscalation(): {
+    escalationId: string | null;
+    assignedAgent: HumanAgent | null;
+    status: "idle" | "requesting" | "queued" | "active" | "resolved";
+    requestHuman: (conversationId: string) => void;
+    endChat: () => void;
+    submitCSAT: (rating: number) => void;
+};
+
+declare function useWidgetConfig(widgetId?: string): {
+    widget: Widget | null;
+    widgetConfig: WidgetConfig | null;
+    isLoading: boolean;
+    error: Error | null;
+    reload: () => Promise<void>;
+};
+
+/**
+ * Push notification event handlers
+ */
+interface PushNotificationHandlers {
+    onNotificationReceived?: (notification: any) => void;
+    onNotificationTapped?: (notification: any) => void;
+}
+/**
+ * Hook options
+ */
+interface UsePushNotificationsOptions {
+    mode?: 'widget' | 'agent';
+    conversationId?: string;
+    autoRegister?: boolean;
+    handlers?: PushNotificationHandlers;
+}
+/**
+ * Enhanced Push Notifications Hook for React Native
+ *
+ * Supports both customer (widget) and agent (dashboard) modes.
+ * Handles permissions, registration, and notification events.
+ *
+ * Works with both React Native CLI and Expo projects. Automatically detects
+ * which push notification system is available:
+ * - React Native CLI: Uses @react-native-firebase/messaging
+ * - Expo: Uses expo-notifications
+ *
+ * SETUP INSTRUCTIONS FOR REACT NATIVE CLI:
+ * 1. Install Firebase dependencies:
+ *    npm install @react-native-firebase/app @react-native-firebase/messaging
+ *
+ * 2. Configure Firebase:
+ *    - Android: Add google-services.json to android/app/
+ *      Apply plugin in android/app/build.gradle: apply plugin: 'com.google.gms.google-services'
+ *    - iOS: Add GoogleService-Info.plist to ios/ and configure APNs
+ *      Add FirebaseAppDelegate methods in AppDelegate.m
+ *
+ * 3. Add permissions to manifests:
+ *    - Android: INTERNET, VIBRATE, RECEIVE_BOOT_COMPLETED in AndroidManifest.xml
+ *    - iOS: User Notifications capability in Xcode
+ *
+ * 4. For iOS, register for remote notifications in AppDelegate:
+ *    - [UNUserNotificationCenter currentNotificationCenter].delegate = self;
+ *    - [application registerForRemoteNotifications];
+ *
+ * SETUP INSTRUCTIONS FOR EXPO:
+ * 1. Install expo-notifications:
+ *    npx expo install expo-notifications
+ *
+ * 2. Configure in app.config.js:
+ *    Add appropriate configuration for notifications
+ */
+declare function usePushNotifications(options?: UsePushNotificationsOptions): {
+    requestPermission: () => Promise<boolean>;
+    registerDevice: (convId?: string, pushToken?: string, bundleId?: string) => Promise<Device | null>;
+    registerAgentDevice: (pushToken?: string, deviceName?: string) => Promise<any>;
+    unregisterDevice: () => Promise<void>;
+    device: Device | null;
+    isRegistered: boolean;
+    isInitialized: boolean;
+    permissionStatus: "granted" | "denied" | "undetermined";
+};
+
+declare function useAttachments(conversationId?: string): {
+    uploading: boolean;
+    uploadProgress: number;
+    uploadAttachment: (file: {
+        uri: string;
+        type?: string;
+        name?: string;
+    }, attachmentType: "IMAGE" | "AUDIO" | "VIDEO" | "DOCUMENT" | "VOICE_NOTE") => Promise<MessageAttachment>;
+};
+
+declare function useAgents(accountId?: string): {
+    agents: Agent[];
+    isLoading: boolean;
+    error: Error | null;
+    createAgent: (data: AgentCreateRequest) => Promise<Agent>;
+    updateAgent: (id: string, data: AgentUpdateRequest) => Promise<Agent>;
+    deleteAgent: (id: string) => Promise<void>;
+    reload: () => Promise<void>;
+};
+
+declare function useConversations(accountId?: string): {
+    conversations: Conversation[];
+    isLoading: boolean;
+    error: Error | null;
+    resolveConversation: (id: string) => Promise<void>;
+    reload: () => Promise<void>;
+};
+
+declare function useAnalytics(accountId?: string, days?: number): {
+    metrics: ConversationMetrics | null;
+    sentiment: SentimentDistribution | null;
+    feedback: FeedbackStats | null;
+    tokenUsage: TokenUsageMetrics | null;
+    isLoading: boolean;
+    error: Error | null;
+    reload: () => Promise<void>;
+};
+
+declare const storage: {
+    getConversationId(): Promise<string | null>;
+    setConversationId(id: string): Promise<void>;
+    clearConversationId(): Promise<void>;
+    getMessages(conversationId: string): Promise<any[]>;
+    setMessages(conversationId: string, messages: any[]): Promise<void>;
+    getUserIdentity(): Promise<{
+        email?: string;
+        name?: string;
+    } | null>;
+    setUserIdentity(identity: {
+        email?: string;
+        name?: string;
+    }): Promise<void>;
+    getWidgetConfig(widgetId: string): Promise<any | null>;
+    setWidgetConfig(widgetId: string, config: any): Promise<void>;
+};
+
+export { SolveoProvider, type SolveoProviderConfig, type SolveoProviderProps, storage, useAgents, useAnalytics, useAttachments, useChat, useConversations, useEscalation, usePushNotifications, useRealtime, useSolveo, useWidgetConfig };

package/dist/index.d.ts

@@ -0,0 +1,199 @@
+import React, { ReactNode } from 'react';
+import { SolveoClientConfig, SolveoSDK, Socket, CustomerSocketManager, AgentSocketManager, StreamingSocket, Conversation, Message, HumanAgent, Widget, WidgetConfig, Device, MessageAttachment, Agent, AgentCreateRequest, AgentUpdateRequest, ConversationMetrics, SentimentDistribution, FeedbackStats, TokenUsageMetrics } from '@solveo-ai/sdk-core';
+export { Agent, Conversation, ConversationStatus, FeedbackType, Message, MessageAttachment, SentimentType, Widget } from '@solveo-ai/sdk-core';
+
+interface SolveoContextValue {
+    sdk: SolveoSDK;
+    config: SolveoProviderConfig;
+    customerSocket: Socket | null;
+    customerSocketManager: CustomerSocketManager | null;
+    agentSocket: Socket | null;
+    agentSocketManager: AgentSocketManager | null;
+    streamingSocket: StreamingSocket | null;
+    connectCustomerSocket: (conversationId: string) => void;
+    disconnectCustomerSocket: () => void;
+    connectAgentSocket: (token: string) => void;
+    disconnectAgentSocket: () => void;
+    connectStreamingSocket: (conversationId: string) => void;
+    disconnectStreamingSocket: () => void;
+}
+interface SolveoProviderConfig extends Omit<SolveoClientConfig, 'platform'> {
+    user?: {
+        email?: string;
+        name?: string;
+        id?: string;
+    };
+    autoConnectCustomer?: boolean;
+    autoConnectAgent?: boolean;
+    conversationId?: string;
+    onError?: (error: Error) => void;
+}
+interface SolveoProviderProps {
+    children: ReactNode;
+    config: SolveoProviderConfig;
+}
+declare function SolveoProvider({ children, config }: SolveoProviderProps): React.JSX.Element;
+declare function useSolveo(): SolveoContextValue;
+
+interface UseChatOptions {
+    widgetId?: string;
+    agentId?: string;
+    persistConversation?: boolean;
+}
+declare function useChat(options?: UseChatOptions): {
+    conversation: Conversation | null;
+    messages: Message[];
+    isLoading: boolean;
+    isStreaming: boolean;
+    streamingContent: string;
+    error: Error | null;
+    createConversation: () => Promise<Conversation>;
+    sendMessage: (content: string) => Promise<void>;
+    loadMessages: (conversationId: string) => Promise<void>;
+    submitFeedback: (messageId: string, rating: "THUMBS_UP" | "THUMBS_DOWN") => Promise<void>;
+};
+
+declare function useRealtime(): {
+    isConnected: boolean;
+    agentTyping: boolean;
+    queuePosition: number | null;
+    estimatedWait: number | null;
+};
+
+declare function useEscalation(): {
+    escalationId: string | null;
+    assignedAgent: HumanAgent | null;
+    status: "idle" | "requesting" | "queued" | "active" | "resolved";
+    requestHuman: (conversationId: string) => void;
+    endChat: () => void;
+    submitCSAT: (rating: number) => void;
+};
+
+declare function useWidgetConfig(widgetId?: string): {
+    widget: Widget | null;
+    widgetConfig: WidgetConfig | null;
+    isLoading: boolean;
+    error: Error | null;
+    reload: () => Promise<void>;
+};
+
+/**
+ * Push notification event handlers
+ */
+interface PushNotificationHandlers {
+    onNotificationReceived?: (notification: any) => void;
+    onNotificationTapped?: (notification: any) => void;
+}
+/**
+ * Hook options
+ */
+interface UsePushNotificationsOptions {
+    mode?: 'widget' | 'agent';
+    conversationId?: string;
+    autoRegister?: boolean;
+    handlers?: PushNotificationHandlers;
+}
+/**
+ * Enhanced Push Notifications Hook for React Native
+ *
+ * Supports both customer (widget) and agent (dashboard) modes.
+ * Handles permissions, registration, and notification events.
+ *
+ * Works with both React Native CLI and Expo projects. Automatically detects
+ * which push notification system is available:
+ * - React Native CLI: Uses @react-native-firebase/messaging
+ * - Expo: Uses expo-notifications
+ *
+ * SETUP INSTRUCTIONS FOR REACT NATIVE CLI:
+ * 1. Install Firebase dependencies:
+ *    npm install @react-native-firebase/app @react-native-firebase/messaging
+ *
+ * 2. Configure Firebase:
+ *    - Android: Add google-services.json to android/app/
+ *      Apply plugin in android/app/build.gradle: apply plugin: 'com.google.gms.google-services'
+ *    - iOS: Add GoogleService-Info.plist to ios/ and configure APNs
+ *      Add FirebaseAppDelegate methods in AppDelegate.m
+ *
+ * 3. Add permissions to manifests:
+ *    - Android: INTERNET, VIBRATE, RECEIVE_BOOT_COMPLETED in AndroidManifest.xml
+ *    - iOS: User Notifications capability in Xcode
+ *
+ * 4. For iOS, register for remote notifications in AppDelegate:
+ *    - [UNUserNotificationCenter currentNotificationCenter].delegate = self;
+ *    - [application registerForRemoteNotifications];
+ *
+ * SETUP INSTRUCTIONS FOR EXPO:
+ * 1. Install expo-notifications:
+ *    npx expo install expo-notifications
+ *
+ * 2. Configure in app.config.js:
+ *    Add appropriate configuration for notifications
+ */
+declare function usePushNotifications(options?: UsePushNotificationsOptions): {
+    requestPermission: () => Promise<boolean>;
+    registerDevice: (convId?: string, pushToken?: string, bundleId?: string) => Promise<Device | null>;
+    registerAgentDevice: (pushToken?: string, deviceName?: string) => Promise<any>;
+    unregisterDevice: () => Promise<void>;
+    device: Device | null;
+    isRegistered: boolean;
+    isInitialized: boolean;
+    permissionStatus: "granted" | "denied" | "undetermined";
+};
+
+declare function useAttachments(conversationId?: string): {
+    uploading: boolean;
+    uploadProgress: number;
+    uploadAttachment: (file: {
+        uri: string;
+        type?: string;
+        name?: string;
+    }, attachmentType: "IMAGE" | "AUDIO" | "VIDEO" | "DOCUMENT" | "VOICE_NOTE") => Promise<MessageAttachment>;
+};
+
+declare function useAgents(accountId?: string): {
+    agents: Agent[];
+    isLoading: boolean;
+    error: Error | null;
+    createAgent: (data: AgentCreateRequest) => Promise<Agent>;
+    updateAgent: (id: string, data: AgentUpdateRequest) => Promise<Agent>;
+    deleteAgent: (id: string) => Promise<void>;
+    reload: () => Promise<void>;
+};
+
+declare function useConversations(accountId?: string): {
+    conversations: Conversation[];
+    isLoading: boolean;
+    error: Error | null;
+    resolveConversation: (id: string) => Promise<void>;
+    reload: () => Promise<void>;
+};
+
+declare function useAnalytics(accountId?: string, days?: number): {
+    metrics: ConversationMetrics | null;
+    sentiment: SentimentDistribution | null;
+    feedback: FeedbackStats | null;
+    tokenUsage: TokenUsageMetrics | null;
+    isLoading: boolean;
+    error: Error | null;
+    reload: () => Promise<void>;
+};
+
+declare const storage: {
+    getConversationId(): Promise<string | null>;
+    setConversationId(id: string): Promise<void>;
+    clearConversationId(): Promise<void>;
+    getMessages(conversationId: string): Promise<any[]>;
+    setMessages(conversationId: string, messages: any[]): Promise<void>;
+    getUserIdentity(): Promise<{
+        email?: string;
+        name?: string;
+    } | null>;
+    setUserIdentity(identity: {
+        email?: string;
+        name?: string;
+    }): Promise<void>;
+    getWidgetConfig(widgetId: string): Promise<any | null>;
+    setWidgetConfig(widgetId: string, config: any): Promise<void>;
+};
+
+export { SolveoProvider, type SolveoProviderConfig, type SolveoProviderProps, storage, useAgents, useAnalytics, useAttachments, useChat, useConversations, useEscalation, usePushNotifications, useRealtime, useSolveo, useWidgetConfig };