@bootdesk/js-web-adapter-react 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,395 @@
+import React, { Component, ReactNode } from 'react';
+import { WebChatClient, Message, Card, CustomCard, WebChatClientConfig, BroadcastClient, PushConfig, PushSubscriptionStatus } from '@bootdesk/js-web-adapter-core';
+export { Card, CustomCard, LaravelEchoBroadcastClient, Message, PHPCard, PushConfig, PushEventData, PushManager, PushSubscriptionStatus, PusherBroadcastClient, User, WebChatClient, createPushSubscriptionHandlers } from '@bootdesk/js-web-adapter-core';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+interface PendingAttachment {
+    id: string;
+    file: File;
+    name: string;
+    mimeType: string;
+    size: number;
+    status: "pending" | "uploading" | "uploaded" | "error";
+    progress: number;
+    url?: string;
+    error?: string;
+}
+interface SignedUploadUrl {
+    uploadUrl: string;
+    finalUrl: string;
+    headers?: Record<string, string>;
+    metadata?: Record<string, unknown>;
+}
+interface AttachmentUploadConfig {
+    requestSignedUrl: (file: {
+        name: string;
+        mimeType: string;
+        size: number;
+    }) => Promise<SignedUploadUrl>;
+    uploadToSignedUrl: (signedUrl: SignedUploadUrl, file: File, onProgress?: (pct: number) => void) => Promise<boolean>;
+    confirmUpload: (signedUrl: SignedUploadUrl, fileMeta: {
+        name: string;
+        mimeType: string;
+        size: number;
+    }) => Promise<string>;
+}
+interface SimpleUploadConfig {
+    endpoint: string;
+    headers?: Record<string, string>;
+}
+type UploadConfig = AttachmentUploadConfig | SimpleUploadConfig;
+
+type DisplayMode = "floating" | "fullscreen" | "embedded";
+type ThemeMode = "light" | "dark" | "auto";
+interface ChatWidgetProps {
+    client: WebChatClient;
+    initialMode?: DisplayMode;
+    theme?: ThemeMode;
+    onThemeChange?: (theme: ThemeMode) => void;
+    position?: "bottom-right" | "bottom-left" | "top-right" | "top-left";
+    className?: {
+        container?: string;
+        header?: string;
+        messageList?: string;
+        inputArea?: string;
+    };
+    showClose?: boolean;
+    showFullscreenToggle?: boolean;
+    title?: string;
+    placeholder?: string;
+    onOpen?: () => void;
+    onClose?: () => void;
+    embedded?: boolean;
+    floatingButton?: {
+        icon?: React.ReactNode;
+        openIcon?: React.ReactNode;
+        badgeCount?: number;
+        size?: number;
+        backgroundColor?: string;
+        ariaLabel?: string;
+        className?: string;
+    };
+    enableAttachments?: boolean;
+    uploadConfig?: UploadConfig;
+    accept?: string;
+    maxFileSize?: number;
+    renderPushPrompt?: () => React.ReactNode;
+}
+declare function ChatWidget({ client, initialMode, theme: themeProp, onThemeChange, position, className, showClose, showFullscreenToggle, title, placeholder, onOpen, onClose, embedded, floatingButton, enableAttachments, uploadConfig, accept, maxFileSize, renderPushPrompt, }: ChatWidgetProps): React.JSX.Element;
+
+interface HeaderProps {
+    title?: string;
+    onClose?: () => void;
+    onToggleFullscreen?: () => void;
+    isFullscreen?: boolean;
+    showConnectionStatus?: boolean;
+    isConnected?: boolean;
+    className?: string;
+    theme?: string;
+    onThemeChange?: (theme: "light" | "dark" | "auto") => void;
+}
+declare function Header({ title, onClose, onToggleFullscreen, isFullscreen, showConnectionStatus, isConnected, className, theme, onThemeChange, }: HeaderProps): React.JSX.Element;
+
+interface MessageListProps {
+    messages: Message[];
+    currentUserId: string;
+    isLoading?: boolean;
+    onReactionClick?: (messageId: string, emoji: string) => void;
+    onActionClick?: (messageId: string, actionId: string, value: string) => void;
+    className?: string;
+}
+declare function MessageList({ messages, currentUserId, isLoading, onReactionClick, onActionClick, className, }: MessageListProps): React.JSX.Element;
+
+interface MessageContentProps {
+    message: Message;
+    onActionClick?: (messageId: string, actionId: string, value: string) => void;
+}
+declare function MessageContent({ message, onActionClick }: MessageContentProps): React.JSX.Element;
+
+interface InputAreaProps {
+    onSend: (text: string, attachments: Array<{
+        url: string;
+        name: string;
+        mimeType: string;
+        size: number;
+    }>) => Promise<void>;
+    disabled?: boolean;
+    placeholder?: string;
+    className?: string;
+    enableAttachments?: boolean;
+    uploadConfig?: UploadConfig;
+    accept?: string;
+    maxFileSize?: number;
+}
+declare function InputArea({ onSend, disabled, placeholder, className, enableAttachments, uploadConfig, accept, maxFileSize, }: InputAreaProps): React.JSX.Element;
+
+interface TypingIndicatorProps {
+    users?: string[];
+}
+declare function TypingIndicator({ users }: TypingIndicatorProps): React.JSX.Element;
+
+interface FloatingButtonProps {
+    onClick: () => void;
+    isOpen: boolean;
+    position?: "bottom-right" | "bottom-left" | "top-right" | "top-left";
+    className?: string;
+    icon?: React.ReactNode;
+    openIcon?: React.ReactNode;
+    badgeCount?: number;
+    size?: number;
+    backgroundColor?: string;
+    ariaLabel?: string;
+}
+declare function FloatingButton({ onClick, isOpen, position, className, icon, openIcon, badgeCount, size, backgroundColor, ariaLabel, }: FloatingButtonProps): React.JSX.Element;
+
+interface CardRendererProps {
+    card: Card | CustomCard;
+    onActionClick?: (actionId: string, value: string) => void;
+}
+type CardRenderer$1 = React.ComponentType<CardRendererProps>;
+type CardRendererMap = Map<string, CardRenderer$1>;
+
+declare function CardRenderer({ card, onActionClick }: CardRendererProps): React.JSX.Element | null;
+
+declare function DefaultCard({ card: rawCard, onActionClick, }: CardRendererProps): React.JSX.Element | null;
+
+declare function ImageCardComponent({ card: rawCard }: CardRendererProps): React.JSX.Element | null;
+
+declare function FileCardComponent({ card: rawCard }: CardRendererProps): React.JSX.Element | null;
+
+interface CardContextValue {
+    renderers: CardRendererMap;
+    registerRenderer: (type: string, renderer: CardRenderer$1) => void;
+    getRenderer: (type: string) => CardRenderer$1 | undefined;
+}
+interface CardProviderProps {
+    children: React.ReactNode;
+    renderers?: Record<string, CardRenderer$1>;
+}
+declare function CardProvider({ children, renderers }: CardProviderProps): React.JSX.Element;
+declare function useCardRegistry(): CardContextValue;
+
+interface ChatContextValue {
+    client: WebChatClient;
+}
+interface ChatProviderProps {
+    children: React.ReactNode;
+    client: WebChatClient;
+    cardRenderers?: Record<string, CardRenderer$1>;
+}
+declare function ChatProvider({ children, client, cardRenderers, }: ChatProviderProps): React.JSX.Element;
+declare function useChatContext(): ChatContextValue;
+
+declare function useChatClient(config: Omit<WebChatClientConfig, "broadcastClient"> & {
+    broadcastClient?: BroadcastClient;
+}): WebChatClient;
+
+interface UseMessagesResult {
+    messages: Message[];
+    loading: boolean;
+    isLoadingHistory: boolean;
+    hasMore: boolean;
+    loadMore: () => Promise<void>;
+    reloadMessages: () => Promise<void>;
+    retryLoad: () => Promise<void>;
+    loadError: Error | null;
+    canEdit: boolean;
+    canDelete: boolean;
+    canReact: boolean;
+    sendMessage: (text: string, attachments?: Array<{
+        url: string;
+        name: string;
+        mimeType: string;
+        size: number;
+    }>) => Promise<void>;
+    editMessage: (id: string, text: string) => Promise<void>;
+    deleteMessage: (id: string) => Promise<void>;
+    addReaction: (id: string, emoji: string) => Promise<void>;
+    removeReaction: (id: string, emoji: string) => Promise<void>;
+}
+declare function useMessages(client: WebChatClient, enabled?: boolean): UseMessagesResult;
+
+interface StreamingState {
+    messageId: string;
+    fullText: string;
+    isComplete: boolean;
+}
+interface UseStreamingResult {
+    streamingMessages: Map<string, StreamingState>;
+    isStreaming: boolean;
+}
+declare function useStreaming(client: WebChatClient): UseStreamingResult;
+
+interface UseTypingResult {
+    typingUsers: Set<string>;
+    isSomeoneTyping: boolean;
+}
+declare function useTyping(client: WebChatClient): UseTypingResult;
+
+declare function renderMarkdown(text: string): string;
+declare function MarkdownRenderer({ text, className, }: {
+    text: string;
+    className?: string;
+}): React.JSX.Element;
+
+interface ErrorBoundaryProps {
+    children: ReactNode;
+    fallback?: ReactNode | ((error: Error) => ReactNode);
+    onError?: (error: Error, errorInfo: React.ErrorInfo) => void;
+}
+interface ErrorBoundaryState {
+    error: Error | null;
+}
+declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    constructor(props: ErrorBoundaryProps);
+    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
+    componentDidCatch(error: Error, errorInfo: React.ErrorInfo): void;
+    render(): ReactNode;
+}
+
+interface DropzoneProps {
+    onFilesSelected: (files: FileList | File[]) => void;
+    disabled?: boolean;
+    accept?: string;
+    maxSize?: number;
+    multiple?: boolean;
+    className?: string;
+}
+declare function Dropzone({ onFilesSelected, disabled, accept, maxSize, multiple, className, }: DropzoneProps): React.JSX.Element;
+
+interface AttachmentListProps {
+    attachments: PendingAttachment[];
+    onRemove?: (id: string) => void;
+    className?: string;
+}
+declare function AttachmentList({ attachments, onRemove, className, }: AttachmentListProps): React.JSX.Element;
+
+declare function useAttachmentUpload(uploadConfig: UploadConfig): {
+    attachments: PendingAttachment[];
+    addFiles: (files: FileList | File[]) => void;
+    removeAttachment: (id: string) => void;
+    clearAttachments: () => void;
+    resetUploads: () => void;
+    getUploadedAttachments: () => PendingAttachment[];
+    isUploading: boolean;
+    isComplete: boolean;
+};
+
+interface LocaleStrings {
+    chatWidget: {
+        title: string;
+        placeholder: string;
+        openChat: string;
+        closeChat: string;
+        connectionStatus: {
+            connected: string;
+            disconnected: string;
+        };
+    };
+    inputArea: {
+        send: string;
+        uploading: string;
+        dropzone: {
+            dropFiles: string;
+            dropOrClick: string;
+        };
+    };
+    typingIndicator: {
+        typing: string;
+        isTyping: string;
+    };
+    messageList: {
+        emptyState: string;
+    };
+    attachmentList: {
+        remove: string;
+        uploadFailed: string;
+    };
+    header: {
+        enterFullscreen: string;
+        exitFullscreen: string;
+        closeChat: string;
+        lightMode: string;
+        darkMode: string;
+        autoMode: string;
+    };
+    floatingButton: {
+        openChat: string;
+        closeChat: string;
+    };
+    common: {
+        loading: string;
+        error: string;
+        retry: string;
+        cancel: string;
+        download: string;
+    };
+}
+type SupportedLocale = "en" | "en-US" | "en-GB" | "pt" | "pt-BR" | "pt-PT" | "es";
+type PartialLocaleStrings = Partial<{
+    [K in keyof LocaleStrings]: Partial<LocaleStrings[K]>;
+}> & {
+    chatWidget?: Partial<LocaleStrings["chatWidget"]> & {
+        connectionStatus?: Partial<LocaleStrings["chatWidget"]["connectionStatus"]>;
+    };
+    inputArea?: Partial<LocaleStrings["inputArea"]> & {
+        dropzone?: Partial<LocaleStrings["inputArea"]["dropzone"]>;
+    };
+    messageList?: Partial<LocaleStrings["messageList"]>;
+    common?: Partial<LocaleStrings["common"]>;
+};
+interface LocaleConfig {
+    locale: string;
+    overrides?: PartialLocaleStrings;
+}
+
+interface LocaleContextValue {
+    locale: string;
+    strings: LocaleStrings;
+    t: (path: string) => string;
+}
+interface LocaleProviderProps {
+    children: React.ReactNode;
+    locale?: LocaleConfig | string;
+}
+declare function LocaleProvider({ children, locale }: LocaleProviderProps): React.JSX.Element;
+declare function useLocale(): LocaleContextValue;
+
+declare function registerLocale(locale: string, strings: LocaleStrings): void;
+declare function getAvailableLocales(): string[];
+
+interface PushPermissionPromptProps {
+    autoHide?: boolean;
+    title?: string;
+    description?: string;
+    onStatusChange?: (enabled: boolean) => void;
+    getVapidPublicKey: () => Promise<string>;
+    onSubscribe: (sub: PushSubscriptionJSON) => Promise<void>;
+    onUnsubscribe: (sub: PushSubscriptionJSON) => Promise<void>;
+}
+declare function PushPermissionPrompt({ autoHide, title, description, onStatusChange, getVapidPublicKey, onSubscribe, onUnsubscribe, }: PushPermissionPromptProps): react_jsx_runtime.JSX.Element | null;
+
+interface PushToggleProps {
+    getVapidPublicKey: () => Promise<string>;
+    onSubscribe: (sub: PushSubscriptionJSON) => Promise<void>;
+    onUnsubscribe: (sub: PushSubscriptionJSON) => Promise<void>;
+}
+declare function PushToggle({ getVapidPublicKey, onSubscribe, onUnsubscribe }: PushToggleProps): react_jsx_runtime.JSX.Element;
+
+interface UsePushNotificationsOptions {
+    enabled?: boolean;
+    getVapidPublicKey: () => Promise<string>;
+    onSubscribe: PushConfig["onSubscribe"];
+    onUnsubscribe: PushConfig["onUnsubscribe"];
+    serviceWorkerUrl?: string;
+    notificationOptions?: PushConfig["notificationOptions"];
+}
+declare function usePushNotifications(options: UsePushNotificationsOptions): {
+    status: PushSubscriptionStatus;
+    isSupported: boolean;
+    isSubscribed: boolean;
+    subscribe: () => Promise<void>;
+    unsubscribe: () => Promise<void>;
+};
+
+export { AttachmentList, type AttachmentUploadConfig, CardProvider, CardRenderer, type CardRendererProps, type CardRenderer$1 as CardRendererType, ChatProvider, ChatWidget, type ChatWidgetProps, DefaultCard, Dropzone, ErrorBoundary, FileCardComponent, FloatingButton, Header, ImageCardComponent, InputArea, type LocaleConfig, LocaleProvider, type LocaleStrings, MarkdownRenderer, MessageContent, MessageList, type PartialLocaleStrings, type PendingAttachment, PushPermissionPrompt, PushToggle, type SignedUploadUrl, type SimpleUploadConfig, type SupportedLocale, TypingIndicator, type UploadConfig, getAvailableLocales, registerLocale, renderMarkdown, useAttachmentUpload, useCardRegistry, useCardRegistry as useCardRendererRegistry, useChatClient, useChatContext, useLocale, useMessages, usePushNotifications, useStreaming, useTyping };