@adatechnology/conversations-ui 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,542 @@
+import * as react from 'react';
+import react__default, { ReactNode, FormEvent } from 'react';
+
+interface ConversationsUIConfig {
+    apiBaseUrl: string;
+    theme?: ConversationsTheme;
+    features?: ConversationsFeatures;
+}
+interface ConversationsTheme {
+    primaryColor?: string;
+    backgroundColor?: string;
+    bubbleSent?: string;
+    bubbleReceived?: string;
+    textPrimary?: string;
+    textSecondary?: string;
+}
+interface ConversationsFeatures {
+    audio?: boolean;
+    documents?: boolean;
+    emoji?: boolean;
+    darkMode?: boolean;
+}
+interface MessagePayload {
+    id: string;
+    type: 'text' | 'image' | 'video' | 'audio' | 'document' | 'sticker' | 'template';
+    content?: string;
+    caption?: string;
+    mediaUrl?: string;
+    base64?: string;
+    uploadId?: string;
+    mediaId?: string;
+    mimeType?: string;
+    filename?: string;
+    sizeBytes?: number;
+    direction: 'inbound' | 'outbound';
+    sender: 'bot' | 'customer' | 'agent';
+    timestamp: string;
+    status?: 'sent' | 'delivered' | 'read' | 'failed';
+    readAt?: string;
+    agentName?: string | null;
+    templateName?: string;
+    isFirstInGroup?: boolean;
+    isLastInGroup?: boolean;
+}
+
+type ResolveMediaUrl = (message: MessagePayload) => Promise<string | null>;
+interface MediaRendererProps {
+    message: MessagePayload;
+    onLightbox: (src: string) => void;
+    onResolveUrl?: ResolveMediaUrl;
+}
+declare function MediaRenderer({ message, onLightbox, onResolveUrl }: MediaRendererProps): react.JSX.Element | null;
+
+interface MessageBubbleProps {
+    message: MessagePayload;
+    isMine: boolean;
+    senderName?: string | null;
+    isFirstInGroup?: boolean;
+    isSelecting?: boolean;
+    isSelected?: boolean;
+    onToggleSelect?: () => void;
+    onResolveMediaUrl?: ResolveMediaUrl;
+}
+declare function MessageBubble({ message, isMine, senderName, isFirstInGroup, isSelecting, isSelected, onToggleSelect, onResolveMediaUrl, }: MessageBubbleProps): react.JSX.Element;
+
+interface ConversationWallpaperProps {
+    children?: ReactNode;
+    className?: string;
+}
+declare function ConversationWallpaper({ children, className }: ConversationWallpaperProps): react.JSX.Element;
+
+interface ConversationLocales {
+    bubble: {
+        customer: string;
+        bot: string;
+        agent: string;
+        document: string;
+        media: string;
+        templateLabel: string;
+        readAt: string;
+        windowExpired: string;
+        viewImage: string;
+        listenAudio: string;
+        viewVideo: string;
+    };
+    selection: {
+        select: string;
+    };
+    dateDivider: {
+        today: string;
+        yesterday: string;
+    };
+}
+type PartialLocales = {
+    [K in keyof ConversationLocales]?: Partial<ConversationLocales[K]>;
+};
+interface ConversationLocalesProviderProps {
+    children: react__default.ReactNode;
+    locales?: PartialLocales;
+}
+declare function ConversationLocalesProvider({ children, locales }: ConversationLocalesProviderProps): react__default.JSX.Element;
+declare function useConversationLocales(): ConversationLocales;
+
+interface AudioPlayerProps {
+    src: string;
+    isMine?: boolean;
+}
+declare function AudioPlayer({ src, isMine }: AudioPlayerProps): react.JSX.Element;
+
+interface EmojiPickerProps {
+    onSelect: (emoji: string) => void;
+    className?: string;
+}
+declare const EmojiPicker: ({ onSelect, className }: EmojiPickerProps) => react.JSX.Element;
+
+interface MessageComposerProps {
+    onSend: (text: string) => void;
+    onAttach?: (file: File) => void;
+    value?: string;
+    onChange?: (value: string) => void;
+    features?: ConversationsFeatures;
+    placeholder?: string;
+    maxLength?: number;
+    disabled?: boolean;
+    acceptedFileTypes?: string;
+}
+declare const MessageComposer: ({ onSend, onAttach, value: externalValue, onChange: externalOnChange, features, placeholder, maxLength, disabled, acceptedFileTypes, }: MessageComposerProps) => react.JSX.Element;
+
+interface WhatsAppMessageEditorProps {
+    value: string;
+    onChange: (value: string) => void;
+    placeholder?: string;
+    placeholders?: readonly string[];
+    rows?: number;
+    previewLabel?: string;
+    emptyPreviewText?: string;
+}
+declare function WhatsAppMessageEditor({ value, onChange, placeholder, placeholders, rows, previewLabel, emptyPreviewText, }: WhatsAppMessageEditorProps): react.JSX.Element;
+
+interface SimpleEmojiPickerProps {
+    onSelect: (emoji: string) => void;
+    label?: string;
+    pickerWidth?: string;
+    pickerMaxHeight?: string;
+}
+declare function SimpleEmojiPicker({ onSelect, label, pickerWidth, pickerMaxHeight }: SimpleEmojiPickerProps): react.JSX.Element;
+
+interface DateDividerProps {
+    iso: string;
+}
+declare function DateDivider({ iso }: DateDividerProps): react.JSX.Element;
+
+interface AvatarProps {
+    name?: string | null;
+    avatarUrl?: string;
+    size?: 'sm' | 'md' | 'lg';
+    className?: string;
+}
+declare function Avatar({ name, avatarUrl, size, className }: AvatarProps): react.JSX.Element;
+
+interface ConversationsApi {
+    fetchMessages(conversationId: string, params?: {
+        limit?: number;
+        before?: string;
+    }): Promise<MessagePayload[]>;
+    fetchConversations(params?: {
+        page?: number;
+        limit?: number;
+        waitingHuman?: boolean;
+        search?: string;
+    }): Promise<ConversationSummary[]>;
+    sendMessage(conversationId: string, text: string): Promise<MessagePayload>;
+    sendMedia(conversationId: string, data: {
+        base64: string;
+        mimeType: string;
+        filename: string;
+        caption?: string;
+    }): Promise<MessagePayload>;
+    sendTemplate(conversationId: string, data: {
+        templateName: string;
+        languageCode?: string;
+        bodyParams?: string[];
+    }): Promise<void>;
+    markRead(conversationId: string): Promise<void>;
+    getContext(conversationId: string): Promise<Record<string, unknown>>;
+    getDocuments(conversationId: string, params?: {
+        search?: string;
+        page?: number;
+    }): Promise<ConversationDocument[]>;
+    getDocumentUrl(uploadId: string): Promise<string>;
+    getMediaProxyUrl(mediaId: string): Promise<{
+        mimeType: string;
+        data: string;
+    }>;
+}
+interface SSEProvider {
+    connectConversationStream(conversationId: string): EventSource;
+    connectGlobalStream(): EventSource;
+}
+interface ConversationSummary {
+    id: string;
+    whatsappNumber: string;
+    clientName?: string;
+    lastContent?: string;
+    lastDirection?: 'inbound' | 'outbound';
+    lastAt: string;
+    lastInboundAt: string | null;
+    mode: 'bot' | 'human';
+    assignedUserId: string | null;
+    waitingHuman: boolean;
+    unread: number;
+    currentState: string;
+}
+interface ConversationDocument {
+    id: string;
+    filename: string;
+    mimeType: string;
+    sizeBytes: number;
+    source: string;
+    linkedAt: string;
+}
+
+interface ConversationListItemProps {
+    conversation: ConversationSummary;
+    active?: boolean;
+    selected?: boolean;
+    onClick?: () => void;
+    onSelect?: (id: string) => void;
+}
+declare const ConversationListItem: ({ conversation, active, selected, onClick, onSelect, }: ConversationListItemProps) => react.JSX.Element;
+
+type ToastType = 'success' | 'error' | 'info';
+interface ToastContextValue {
+    show: (type: ToastType, message: string) => void;
+}
+declare const toast: {
+    show(type: ToastType, message: string): void;
+};
+declare function ToastProvider({ children }: {
+    children: ReactNode;
+}): react.JSX.Element;
+declare function useToast(): ToastContextValue;
+
+interface StatusTicksProps {
+    status: string;
+    title?: string;
+}
+declare function StatusTicks({ status, title }: StatusTicksProps): react.JSX.Element;
+
+interface LightboxProps {
+    imageUrl: string;
+    caption?: string;
+    onClose: () => void;
+}
+declare function Lightbox({ imageUrl, caption, onClose }: LightboxProps): react.JSX.Element;
+
+interface FileIconProps {
+    filename?: string;
+    mimeType?: string;
+    size?: number;
+    className?: string;
+}
+declare function FileIcon({ filename, mimeType, size, className }: FileIconProps): react.JSX.Element;
+
+interface MessageTextProps {
+    message: MessagePayload;
+}
+declare function MessageText({ message }: MessageTextProps): react.JSX.Element;
+
+interface MessageTimestampProps {
+    timestamp: string;
+    status?: string;
+    isOutbound: boolean;
+}
+declare function MessageTimestamp({ timestamp, status, isOutbound }: MessageTimestampProps): react.JSX.Element;
+
+interface MessageTailProps {
+    isOutbound: boolean;
+}
+declare function MessageTail({ isOutbound }: MessageTailProps): react.JSX.Element;
+
+declare function useDarkMode(): {
+    isDark: boolean;
+    toggle: () => void;
+};
+
+interface UseWaitingNotificationsResult {
+    unreadCount: number;
+    conversations: ConversationSummary[];
+}
+declare function useWaitingNotifications(): UseWaitingNotificationsResult;
+
+interface ConversationsContextValue {
+    api: ConversationsApi;
+    sse: SSEProvider;
+}
+declare function ConversationsProvider({ api, sse, children, }: {
+    api: ConversationsApi;
+    sse: SSEProvider;
+    children: ReactNode;
+}): react.JSX.Element;
+declare function useConversations(): ConversationsContextValue | null;
+
+interface WhatsAppTemplateSummary {
+    name: string;
+    language: string;
+    displayName: string;
+    shortId: string;
+    status: string;
+    bodyText: string | null;
+    variableCount: number;
+}
+interface WhatsAppTemplateVariableSuggestion {
+    token: string;
+    label: string;
+}
+interface WhatsAppTemplateSettingsFormLabels {
+    sectionTitle: string;
+    sectionDescription: string;
+    templateLabel: string;
+    refreshList: string;
+    errorLoading: string;
+    currentNameSaved: string;
+    selectPlaceholder: string;
+    variablesLabel: string;
+    addVariable: string;
+    removeVariable: string;
+    variablesAvailableTitle: string;
+    variablesAvailableHint: string;
+    variablesMappingHint: string;
+    noVariables: string;
+    save: string;
+    saving: string;
+    saveSuccess: string;
+}
+interface WhatsAppTemplateSettingsFormProps {
+    templates: WhatsAppTemplateSummary[];
+    loadingTemplates?: boolean;
+    templatesError?: boolean;
+    onRefreshTemplates?: () => void;
+    selectedTemplateName: string;
+    onSelectTemplate: (name: string, template: WhatsAppTemplateSummary | undefined) => void;
+    variables: string[];
+    onVariablesChange: (variables: string[]) => void;
+    availableVariables?: WhatsAppTemplateVariableSuggestion[];
+    saving?: boolean;
+    saveSuccess?: boolean;
+    onSave: (event: FormEvent) => void;
+    labels?: Partial<WhatsAppTemplateSettingsFormLabels>;
+}
+declare function WhatsAppTemplateSettingsForm({ templates, loadingTemplates, templatesError, onRefreshTemplates, selectedTemplateName, onSelectTemplate, variables, onVariablesChange, availableVariables, saving, saveSuccess, onSave, labels: labelsOverride, }: WhatsAppTemplateSettingsFormProps): react.JSX.Element;
+
+type WhatsAppTemplateHeaderType = 'NONE' | 'TEXT';
+interface WhatsAppCreateTemplateState {
+    name: string;
+    category: string;
+    language: string;
+    headerType: WhatsAppTemplateHeaderType;
+    headerText: string;
+    bodyText: string;
+    footerText: string;
+}
+interface WhatsAppCreateTemplateResult {
+    ok: boolean;
+    message: string;
+    status?: string;
+}
+interface WhatsAppCreateTemplateFormLabels {
+    sectionTitle: string;
+    sectionDescription: string;
+    nameLabel: string;
+    nameHint: string;
+    categoryLabel: string;
+    languageLabel: string;
+    headerLabel: string;
+    headerHint: string;
+    headerNone: string;
+    headerText: string;
+    headerPlaceholder: string;
+    bodyLabel: string;
+    bodyHint: string;
+    bodyPlaceholder: string;
+    detectedVariables: string;
+    variableLabel: (index: number) => string;
+    configureHintPrefix: string;
+    configureHintLink: string;
+    configureHintSuffix: string;
+    footerLabel: string;
+    footerHint: string;
+    footerPlaceholder: string;
+    previewLabel: string;
+    previewOnline: string;
+    previewDescription: string;
+    previewHeaderFallback: string;
+    previewBodyPlaceholder: string;
+    sendForApproval: string;
+    sending: string;
+    successStatus: (status: string) => string;
+}
+interface WhatsAppCreateTemplateFormProps {
+    value: WhatsAppCreateTemplateState;
+    onChange: (value: WhatsAppCreateTemplateState) => void;
+    onSubmit: (event: FormEvent) => void;
+    submitting?: boolean;
+    result?: WhatsAppCreateTemplateResult | null;
+    previewCompanyName?: string;
+    labels?: Partial<WhatsAppCreateTemplateFormLabels>;
+    variableExamples?: readonly string[];
+}
+declare function WhatsAppCreateTemplateForm({ value, onChange, onSubmit, submitting, result, previewCompanyName, labels: labelsOverride, variableExamples, }: WhatsAppCreateTemplateFormProps): react.JSX.Element;
+
+interface WelcomeFarewellFormLabels {
+    sectionTitle: string;
+    welcomeMessage: string;
+    welcomeMessagePlaceholder: string;
+    welcomeMessageHint: string;
+    farewellMessage: string;
+    farewellMessagePlaceholder: string;
+    farewellMessageHint: string;
+    save: string;
+    saving: string;
+    saveSuccess: string;
+}
+interface WelcomeFarewellFormProps {
+    welcomeMessage: string;
+    onWelcomeMessageChange: (value: string) => void;
+    farewellMessage: string;
+    onFarewellMessageChange: (value: string) => void;
+    onSave: (event: FormEvent) => void;
+    saving?: boolean;
+    saveSuccess?: boolean;
+    welcomePlaceholders?: readonly string[];
+    farewellPlaceholders?: readonly string[];
+    labels?: Partial<WelcomeFarewellFormLabels>;
+}
+declare function WelcomeFarewellForm({ welcomeMessage, onWelcomeMessageChange, farewellMessage, onFarewellMessageChange, onSave, saving, saveSuccess, welcomePlaceholders, farewellPlaceholders, labels: labelsOverride, }: WelcomeFarewellFormProps): react.JSX.Element;
+
+interface TopicItem {
+    key: string;
+    label: string;
+    enabled: boolean;
+    message: string;
+}
+interface TopicsFormLabels {
+    sectionTitle: string;
+    sectionDescription: string;
+    messagePlaceholder: string;
+    saveButton: string;
+    saveSuccess: string;
+}
+interface TopicsFormProps {
+    topics: TopicItem[];
+    onToggle: (key: string) => void;
+    onMessageChange: (key: string, message: string) => void;
+    onSave: (event: FormEvent) => void;
+    saving?: boolean;
+    saveSuccess?: boolean;
+    labels?: Partial<TopicsFormLabels>;
+}
+declare function TopicsForm({ topics, onToggle, onMessageChange, onSave, saving, saveSuccess, labels: labelsOverride, }: TopicsFormProps): react.JSX.Element;
+
+interface UseConversationMessagesResult {
+    messages: MessagePayload[];
+    loading: boolean;
+    error: Error | undefined;
+    refetch: () => Promise<void>;
+    sendMessage: (text: string) => Promise<MessagePayload>;
+    sendMedia: (data: {
+        base64: string;
+        mimeType: string;
+        filename: string;
+        caption?: string;
+    }) => Promise<MessagePayload>;
+    sendTemplate: (data: {
+        templateName: string;
+        languageCode?: string;
+        bodyParams?: string[];
+    }) => Promise<void>;
+    markRead: () => Promise<void>;
+}
+declare function useConversationMessages(conversationId: string, params?: {
+    limit?: number;
+    before?: string;
+}): UseConversationMessagesResult;
+
+interface UseConversationListParams {
+    page?: number;
+    limit?: number;
+    waitingHuman?: boolean;
+    search?: string;
+}
+interface UseConversationListResult {
+    conversations: ConversationSummary[];
+    loading: boolean;
+    error: Error | undefined;
+    refetch: () => Promise<void>;
+}
+declare function useConversationList(params?: UseConversationListParams): UseConversationListResult;
+
+interface UseConversationContextResult {
+    context: Record<string, unknown> | undefined;
+    loading: boolean;
+    error: Error | undefined;
+    refetch: () => Promise<void>;
+}
+declare function useConversationContext(conversationId: string): UseConversationContextResult;
+
+interface UseConversationDocumentsParams {
+    search?: string;
+    page?: number;
+}
+interface UseConversationDocumentsResult {
+    documents: ConversationDocument[];
+    loading: boolean;
+    error: Error | undefined;
+    refetch: () => Promise<void>;
+}
+declare function useConversationDocuments(conversationId: string, params?: UseConversationDocumentsParams): UseConversationDocumentsResult;
+
+type ConversationRealtimeHandler = (event: MessageEvent) => void;
+declare function useConversationRealtime(conversationId: string | undefined, onEvent: ConversationRealtimeHandler): void;
+declare function useGlobalRealtime(onEvent: ConversationRealtimeHandler): void;
+
+declare function parseWhatsAppFormatting(text: string): ReactNode[];
+declare function waToHTML(text: string): string;
+declare function htmlToWA(html: string): string;
+declare function waToHTMLInline(text: string): string;
+
+declare function formatPhone(number: string): string;
+declare function phoneInitials(number: string): string;
+
+declare function formatTimestamp(timestamp: string): string;
+declare function formatFileSize(bytes: number): string;
+
+interface AsyncResourceState<T> {
+    data: T | undefined;
+    loading: boolean;
+    error: Error | undefined;
+    refetch: () => Promise<void>;
+}
+
+export { type AsyncResourceState, AudioPlayer, type AudioPlayerProps, Avatar, type AvatarProps, type ConversationDocument, ConversationListItem, type ConversationListItemProps, type ConversationLocales, ConversationLocalesProvider, type ConversationLocalesProviderProps, type ConversationRealtimeHandler, type ConversationSummary, ConversationWallpaper, type ConversationWallpaperProps, type ConversationsApi, type ConversationsFeatures, ConversationsProvider, type ConversationsTheme, type ConversationsUIConfig, DateDivider, type DateDividerProps, EmojiPicker, type EmojiPickerProps, FileIcon, type FileIconProps, Lightbox, type LightboxProps, MediaRenderer, type MediaRendererProps, MessageBubble, type MessageBubbleProps, MessageComposer, type MessageComposerProps, type MessagePayload, MessageTail, MessageText, type MessageTextProps, MessageTimestamp, type ResolveMediaUrl, type SSEProvider, SimpleEmojiPicker, type SimpleEmojiPickerProps, StatusTicks, type StatusTicksProps, ToastProvider, type TopicItem, TopicsForm, type TopicsFormLabels, type TopicsFormProps, type UseConversationContextResult, type UseConversationDocumentsParams, type UseConversationDocumentsResult, type UseConversationListParams, type UseConversationListResult, type UseConversationMessagesResult, WelcomeFarewellForm, type WelcomeFarewellFormLabels, type WelcomeFarewellFormProps, WhatsAppCreateTemplateForm, type WhatsAppCreateTemplateFormLabels, type WhatsAppCreateTemplateFormProps, type WhatsAppCreateTemplateResult, type WhatsAppCreateTemplateState, WhatsAppMessageEditor, type WhatsAppMessageEditorProps, type WhatsAppTemplateHeaderType, WhatsAppTemplateSettingsForm, type WhatsAppTemplateSettingsFormLabels, type WhatsAppTemplateSettingsFormProps, type WhatsAppTemplateSummary, type WhatsAppTemplateVariableSuggestion, formatFileSize, formatPhone, formatTimestamp, htmlToWA, parseWhatsAppFormatting, phoneInitials, toast, useConversationContext, useConversationDocuments, useConversationList, useConversationLocales, useConversationMessages, useConversationRealtime, useConversations, useDarkMode, useGlobalRealtime, useToast, useWaitingNotifications, waToHTML, waToHTMLInline };