@sendbird/ai-agent-messenger-react-native 0.0.1-beta.6 → 1.0.0

package/dist/index.d.ts

@@ -28,6 +28,7 @@ import { PropsWithChildren } from 'react';
 import { ReactNode } from 'react';
 import { RefAttributes } from 'react';
 import { RefObject } from 'react';
+import type * as RNPermissions from 'react-native-permissions';
 import { SendbirdChatParams } from '@sendbird/chat';
 import { SendbirdChatWith } from '@sendbird/chat';
 import { SendbirdError } from '@sendbird/chat';
@@ -35,6 +36,7 @@ import { SessionHandler } from '@sendbird/chat';
 import { User } from '@sendbird/chat';
 import { UserMessage } from '@sendbird/chat/message';
 import { UserMessageCreateParams } from '@sendbird/chat/message';
+import { ViewProps } from 'react-native';
 import { ViewStyle } from 'react-native';
 
 declare interface ActionbookInfo {
@@ -106,6 +108,7 @@ declare interface AIAgentContextValue {
     dispatcher: Dispatcher;
 
     cache: AIAgentCache;
+    networkStateAdapter?: NetworkStateAdapter;
 
     queryParams?: AIAgentQueryParams;
     config?: AIAgentConfig;
@@ -133,6 +136,11 @@ declare interface AIAgentConversationContextValue {
     };
 
     state: {
+        streamAnimation: {
+            isAnimating: boolean;
+            start: (id: string | number) => void;
+            stop: (id: string | number) => void;
+        };
         input: InputState;
     };
 }
@@ -317,6 +325,7 @@ declare interface AIAgentStringSet {
         input_placeholder_disabled: string;
         input_placeholder_wait_ai_agent_response: string;
         input_placeholder_active_form: string;
+        input_placeholder_reconnecting: string;
 
         unknown_message_type: string;
         powered_by: string;
@@ -332,6 +341,7 @@ declare interface AIAgentStringSet {
     conversation_list: {
         header_title: string;
         ended: string;
+        footer_title: string;
     };
 
     date_format: {
@@ -515,9 +525,10 @@ declare interface ConversationContextProps extends PropsWithChildren {
     onClearChannelUrl?: () => void;
     onNavigateToConversationList?: () => void;
     onClose?: () => void;
+    shouldMarkAsRead?: boolean;
 }
 
-export declare const ConversationContextProvider: ({ channelUrl, onClearChannelUrl, onClose, onNavigateToConversationList, children, }: ConversationContextProps) => JSX.Element;
+export declare const ConversationContextProvider: (props: ConversationContextProps) => JSX.Element;
 
 declare interface ConversationContextValue extends AIAgentConversationContextValue {
     scrollSource: ConversationScrollContextValue;
@@ -538,9 +549,13 @@ export declare const ConversationHeaderLayout: {
     defaults: {
         template: ComponentType<ConversationHeaderTemplateProps>;
         components: {
-            Start: () => ReactNode;
+            StartArea: () => ReactNode;
+            TitleArea: () => ReactNode;
+            EndArea: () => ReactNode;
+            MenuButton: () => ReactNode;
             Title: () => ReactNode;
-            End: () => ReactNode;
+            HandoffButton: () => ReactNode;
+            CloseButton: () => ReactNode;
         };
     };
     Template: ({ template, children }: {
@@ -548,23 +563,43 @@ export declare const ConversationHeaderLayout: {
         children?: ReactNode;
     }) => JSX.Element;
     Context: Context<LayoutContextValue<    {
-    Start: () => ReactNode;
+    StartArea: () => ReactNode;
+    TitleArea: () => ReactNode;
+    EndArea: () => ReactNode;
+    MenuButton: () => ReactNode;
     Title: () => ReactNode;
-    End: () => ReactNode;
+    HandoffButton: () => ReactNode;
+    CloseButton: () => ReactNode;
     }, ConversationHeaderTemplateProps>>;
     useContext: () => LayoutContextValue<    {
-    Start: () => ReactNode;
+    StartArea: () => ReactNode;
+    TitleArea: () => ReactNode;
+    EndArea: () => ReactNode;
+    MenuButton: () => ReactNode;
     Title: () => ReactNode;
-    End: () => ReactNode;
+    HandoffButton: () => ReactNode;
+    CloseButton: () => ReactNode;
     }, ConversationHeaderTemplateProps>;
 } & {
-    Start: (props: {
+    StartArea: (props: {
+        component: () => ReactNode;
+    }) => null;
+    TitleArea: (props: {
+        component: () => ReactNode;
+    }) => null;
+    EndArea: (props: {
+        component: () => ReactNode;
+    }) => null;
+    MenuButton: (props: {
         component: () => ReactNode;
     }) => null;
     Title: (props: {
         component: () => ReactNode;
     }) => null;
-    End: (props: {
+    HandoffButton: (props: {
+        component: () => ReactNode;
+    }) => null;
+    CloseButton: (props: {
         component: () => ReactNode;
     }) => null;
 };
@@ -650,9 +685,11 @@ export declare const ConversationListHeaderLayout: {
     defaults: {
         template: ComponentType<ConversationListHeaderTemplateProps>;
         components: {
-            Start: () => ReactNode;
+            StartArea: () => ReactNode;
+            TitleArea: () => ReactNode;
+            EndArea: () => ReactNode;
             Title: () => ReactNode;
-            End: () => ReactNode;
+            CloseButton: () => ReactNode;
         };
     };
     Template: ({ template, children }: {
@@ -660,23 +697,33 @@ export declare const ConversationListHeaderLayout: {
         children?: ReactNode;
     }) => JSX.Element;
     Context: Context<LayoutContextValue<    {
-    Start: () => ReactNode;
+    StartArea: () => ReactNode;
+    TitleArea: () => ReactNode;
+    EndArea: () => ReactNode;
     Title: () => ReactNode;
-    End: () => ReactNode;
+    CloseButton: () => ReactNode;
     }, ConversationListHeaderTemplateProps>>;
     useContext: () => LayoutContextValue<    {
-    Start: () => ReactNode;
+    StartArea: () => ReactNode;
+    TitleArea: () => ReactNode;
+    EndArea: () => ReactNode;
     Title: () => ReactNode;
-    End: () => ReactNode;
+    CloseButton: () => ReactNode;
     }, ConversationListHeaderTemplateProps>;
 } & {
-    Start: (props: {
+    StartArea: (props: {
+        component: () => ReactNode;
+    }) => null;
+    TitleArea: (props: {
+        component: () => ReactNode;
+    }) => null;
+    EndArea: (props: {
         component: () => ReactNode;
     }) => null;
     Title: (props: {
         component: () => ReactNode;
     }) => null;
-    End: (props: {
+    CloseButton: (props: {
         component: () => ReactNode;
     }) => null;
 };
@@ -725,7 +772,7 @@ declare interface ConversationScrollContextValue {
     ref: RefObject<FlatList | null>;
     state: {
         distanceFromBottom: number;
-        isAtBottom: boolean;
+        shouldShowScrollButton: boolean;
         bottomSpace?: number;
     };
     props: {
@@ -787,6 +834,15 @@ declare interface Dispatcher {
     ): void;
 }
 
+/** Adapter interface for document picker */
+declare interface DocumentPickerAdapter {
+    /**
+     * Select files from file picker
+     * @returns Array of MediaFiles, or null if cancelled
+     */
+    selectFile: (options?: FilePickerOptions) => Promise<MediaFile[] | null>;
+}
+
 declare type ExpoDocumentPickerModule = typeof ExpoDocumentPicker;
 
 declare type ExpoImagePickerModule = typeof ExpoImagePicker;
@@ -874,8 +930,10 @@ declare interface FilePickerOptions {
     mimeTypes?: string[];
 }
 
-export declare const FixedMessenger: (({ entryPoint, edgeToEdgeEnabled, windowMode, fullscreenInsets, children, }: FixedMessengerProps) => JSX.Element) & {
+export declare const FixedMessenger: (({ entryPoint, edgeToEdgeEnabled, windowMode, fullscreenInsets, initialChannelUrl, windowContainerProps, children, }: FixedMessengerProps) => JSX.Element) & {
     Style: (props: FixedMessengerStyleProps) => null;
+    ConversationChildren: ({ children }: PropsWithChildren) => null;
+    ConversationListChildren: ({ children }: PropsWithChildren) => null;
 };
 
 declare type FixedMessengerMargin = {
@@ -892,6 +950,10 @@ declare interface FixedMessengerProps {
      * @description Initial entry point of the messenger. (Defaults to 'Conversation')
      * */
     entryPoint?: 'Conversation' | 'ConversationList';
+    /**
+     * @description The URL of the channel to open initially when the messenger is first loaded.
+     * */
+    initialChannelUrl?: string;
     /**
      * @description Window mode of the messenger. (Defaults to 'floating')
      * */
@@ -910,6 +972,10 @@ declare interface FixedMessengerProps {
      * @description On Android, when edge-to-edge is enabled, bottom inset will be considered when the soft keyboard is opened to avoid overlapping. (Defaults to true)
      * */
     edgeToEdgeEnabled?: boolean;
+    /**
+     * @description Props to pass to the window container.
+     * */
+    windowContainerProps?: ViewProps;
     children?: ReactNode;
 }
 
@@ -999,10 +1065,26 @@ declare const icons: {
     bad: any;
     'good-filled': any;
     'bad-filled': any;
+    delight: any;
+    'thumbnail-none': any;
 };
 
 declare type IconType = keyof typeof icons;
 
+/** Adapter interface for image picker (camera and gallery) */
+declare interface ImagePickerAdapter {
+    /**
+     * Launch camera to capture a photo
+     * @returns Array with single MediaFile, or null if cancelled
+     */
+    captureCamera: (options?: CameraOptions) => Promise<MediaFile[] | null>;
+    /**
+     * Select photos from gallery
+     * @returns Array of MediaFiles, or null if cancelled
+     */
+    selectFromGallery: (options?: GalleryOptions) => Promise<MediaFile[] | null>;
+}
+
 declare type IncomingBaseMessageProps<T> = T &
 BaseMessageProps<{
     sender: {
@@ -1031,6 +1113,8 @@ BaseMessageProps<{
     onFeedbackUpdate?: (params: { rating: 'good' | 'bad'; comment?: string } | null) => void;
     onSubmitForm?: (params: { key: string; data: Record<string, FormFieldValue> }) => Promise<void>;
     onCancelForm?: (params: { key: string }) => Promise<void>;
+    onStreamAnimationStart?: () => void;
+    onStreamAnimationComplete?: () => void;
 
     // fallbacks
     messageTemplateErrorFallback?: ReactNode;
@@ -1232,6 +1316,7 @@ declare type InputState = {
     | 'ai_responding'
     | 'conversation_closed'
     | 'suggested_replies'
+    | 'reconnecting'
     | (string & {});
 };
 
@@ -1430,27 +1515,27 @@ declare type MultiSelectField = {
 /** Configuration for NativeAdapter */
 declare interface NativeAdapterConfig {
     mmkv: MMKVModule;
-    imagePicker: ExpoImagePickerModule | CommunityImagePickerModule;
-    documentPicker: ExpoDocumentPickerModule | CommunityDocumentPickerModule;
-}
-
-/** Methods available from useNativeAdapterContext() */
-declare interface NativeAdapterContextValue {
     /**
-     * Launch camera to capture a photo
-     * @returns Array with single MediaFile, or null if cancelled
+     * Optional: Image picker module for camera and gallery functionality.
+     * Can be omitted if attachment features are not used.
+     * Supports expo-image-picker or react-native-image-picker.
      */
-    captureCamera: (options?: CameraOptions) => Promise<MediaFile[] | null>;
+    imagePicker?: ExpoImagePickerModule | CommunityImagePickerModule;
     /**
-     * Select photos from gallery
-     * @returns Array of MediaFiles, or null if cancelled
+     * Optional: Document picker module for file selection.
+     * Can be omitted if attachment features are not used.
+     * Supports expo-document-picker or @react-native-documents/picker.
      */
-    selectFromGallery: (options?: GalleryOptions) => Promise<MediaFile[] | null>;
+    documentPicker?: ExpoDocumentPickerModule | CommunityDocumentPickerModule;
     /**
-     * Select files from file picker
-     * @returns Array of MediaFiles, or null if cancelled
+     * Optional: react-native-permissions module.
+     * Only required when using react-native-image-picker (Community version).
      */
-    selectFile: (options?: FilePickerOptions) => Promise<MediaFile[] | null>;
+    permissions?: RNPermissionsModule;
+}
+
+/** Methods available from useNativeAdapterContext() */
+declare interface NativeAdapterContextValue extends ImagePickerAdapter, DocumentPickerAdapter {
     /**
      * Key-value storage interface
      */
@@ -1468,6 +1553,13 @@ declare interface NativeAdapterProviderProps {
     children: ReactNode | ((context: NativeAdapterContextValue) => ReactNode);
 }
 
+declare interface NetworkStateAdapter {
+    /** Returns true if network is currently online */
+    isOnline: () => boolean;
+    /** Subscribe to network state changes. Returns unsubscribe function. */
+    subscribe: (callback: (isOnline: boolean) => void) => () => void;
+}
+
 declare type NumberField = {
     key: string;
     type: 'number';
@@ -1629,6 +1721,8 @@ declare type PositionHorizontal = 'start' | 'end';
 
 declare type PositionVertical = 'top' | 'bottom';
 
+declare type RNPermissionsModule = typeof RNPermissions;
+
 declare type SingleSelectField = {
     key: string;
     type: 'single-select';