@brainfish-ai/components 0.35.19 → 0.36.0

package/dist/components/chat-search/Answer.d.ts

@@ -0,0 +1,36 @@
+import { default as React } from 'react';
+import { SearchResult, FeedbackResponse, AnswerAttachment, AnswerBlock as AnswerBlockType, AnswerState, RedirectRule, Action, NextBestAction, ActionClick, KnowledgeSourceGroup } from './types';
+interface AnswerProps {
+    index: number;
+    favicon?: string;
+    blocks?: AnswerBlockType[];
+    state?: AnswerState;
+    question: string;
+    searchResults?: SearchResult[];
+    searchQueryId?: string;
+    hideCitations?: boolean;
+    feedback?: FeedbackResponse;
+    onFeedback?: (response: FeedbackResponse) => void;
+    disableFeedback?: boolean;
+    textConfig?: {
+        positiveAnswerText?: string;
+        negativeAnswerText?: string;
+        loadingSearchText?: string;
+        loadingAnswerText?: string;
+        uncertaintyFallbackText?: Record<string, string>;
+    };
+    searchIntentId?: string;
+    redirectRules?: RedirectRule[];
+    attachments?: AnswerAttachment[];
+    actions?: Action[];
+    handleActionClick?: (action: ActionClick) => void;
+    nextBestActions?: NextBestAction[];
+    isLastAnswer?: boolean;
+    onFeedbackReasonSubmit?: (reason: string) => void;
+    hasError?: boolean;
+    knowledgeSourceGroups?: KnowledgeSourceGroup[];
+    onKnowledgeGroupSelect?: (group: KnowledgeSourceGroup) => void;
+    statusMessage?: string;
+}
+export declare function Answer({ index, favicon, blocks, question, searchResults, state, searchQueryId, searchIntentId, hideCitations, feedback, onFeedback, disableFeedback, textConfig, redirectRules, attachments, actions, handleActionClick, nextBestActions, isLastAnswer, onFeedbackReasonSubmit, hasError, knowledgeSourceGroups, onKnowledgeGroupSelect, statusMessage, }: AnswerProps): React.JSX.Element;
+export {};

package/dist/components/chat-search/AnswerActions.d.ts

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+import { Action, NextBestAction, ActionClick } from './types';
+interface AnswerActionsProps {
+    actions?: Action[];
+    nextBestActions?: NextBestAction[];
+    isLastAnswer?: boolean;
+    handleActionClick?: (action: ActionClick) => void;
+    searchQueryId: string;
+    searchIntentId?: string;
+    question: string;
+    answer: string;
+}
+declare const AnswerActions: React.FC<AnswerActionsProps>;
+export default AnswerActions;

package/dist/components/chat-search/AnswerBlock.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { AnswerBlock, AnswerState, RedirectRule } from './types';
+export interface AnswerBlockProps {
+    block: AnswerBlock;
+    redirectRules?: RedirectRule[];
+    state: AnswerState;
+}
+export declare function AnswerBlock({ block, redirectRules, state }: AnswerBlockProps): React.JSX.Element | null;

package/dist/components/chat-search/AnswerLoadingStatus.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+export interface AnswerLoadingStatusProps {
+    text: string;
+    className?: string;
+}
+export declare function AnswerLoadingStatus({ text, className }: AnswerLoadingStatusProps): React.JSX.Element;

package/dist/components/chat-search/AttachmentThumbnails.d.ts

@@ -0,0 +1,36 @@
+import { default as React } from 'react';
+type ThumbnailItem = {
+    id: string;
+    src: string;
+    alt?: string;
+    url?: string;
+    status?: 'uploading' | 'uploaded';
+};
+declare const sizeConfig: {
+    readonly xs: {
+        readonly container: "size-12";
+        readonly spinner: "size-3";
+        readonly close: "top-0.5 right-0.5 p-0.5";
+        readonly closeIcon: "size-2";
+    };
+    readonly sm: {
+        readonly container: "size-16";
+        readonly spinner: "size-4";
+        readonly close: "top-0.5 right-0.5 p-0.5";
+        readonly closeIcon: "size-2.5";
+    };
+    readonly md: {
+        readonly container: "size-20";
+        readonly spinner: "size-5";
+        readonly close: "top-1 right-1 p-1";
+        readonly closeIcon: "size-3";
+    };
+};
+interface AttachmentThumbnailsProps {
+    items: ThumbnailItem[];
+    size?: keyof typeof sizeConfig;
+    onRemove?: (id: string) => void;
+    className?: string;
+}
+export declare function AttachmentThumbnails({ items, size, onRemove, className }: AttachmentThumbnailsProps): React.JSX.Element | null;
+export {};

package/dist/components/chat-search/ChatSearch.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+import { ChatSearchState, ChatSearchProps } from './types';
+export interface ChatSearchHandle {
+    createNewThread: (firstQuery?: string) => void;
+    showFollowUpThread: (show: boolean) => void;
+    subscribeToStateChanges: (callback: (state: ChatSearchState) => void) => () => void;
+    focusSearchField: () => void;
+    showCloseButton: (showButton: boolean) => void;
+    loadConversation: (conversationId: string) => void;
+}
+declare const ChatSearch: React.ForwardRefExoticComponent<ChatSearchProps & React.RefAttributes<ChatSearchHandle>>;
+export default ChatSearch;

package/dist/components/chat-search/ChatSearchContext.d.ts

@@ -0,0 +1,37 @@
+import { default as React, ReactNode } from 'react';
+import { Answer } from './types';
+import { AnswerListAction } from './hooks/useAnswerList';
+interface ChatSearchContextProps {
+    query: string;
+    setQuery: React.Dispatch<React.SetStateAction<string>>;
+    queryId: string;
+    setQueryId: React.Dispatch<React.SetStateAction<string>>;
+    followUpQuery: string;
+    setFollowUpQuery: React.Dispatch<React.SetStateAction<string>>;
+    isSearching: boolean;
+    setIsSearching: React.Dispatch<React.SetStateAction<boolean>>;
+    showResults: boolean;
+    setShowResults: React.Dispatch<React.SetStateAction<boolean>>;
+    answers: Answer[];
+    answerListDispatch: React.Dispatch<AnswerListAction>;
+    activeAnswerIndex: number;
+    setActiveAnswerIndex: React.Dispatch<React.SetStateAction<number>>;
+    conversationId: string | undefined;
+    setConversationId: (id: string) => void;
+    clearConversationId: () => void;
+    isLoadingConversation: boolean;
+    setIsLoadingConversation: React.Dispatch<React.SetStateAction<boolean>>;
+    loadError: string;
+    setLoadError: React.Dispatch<React.SetStateAction<string>>;
+    showMobileCloseWidgetButton: boolean;
+    setShowMobileCloseWidgetButton: React.Dispatch<React.SetStateAction<boolean>>;
+    contentTypeEndpoint?: string;
+}
+export declare const ChatSearchProvider: React.FC<{
+    children: ReactNode;
+    searchPath?: string;
+    contentTypeEndpoint?: string;
+    widgetKey?: string;
+}>;
+export declare const useChatSearch: () => ChatSearchContextProps;
+export {};

package/dist/components/chat-search/FollowUpQuestions.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+interface FollowUpQuestionsProps {
+    questions: string[];
+    onQuestionClick: (question: string) => void;
+}
+export declare function FollowUpQuestions({ questions, onQuestionClick }: FollowUpQuestionsProps): React.JSX.Element | null;
+export {};

package/dist/components/chat-search/FollowUpSearchBar.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+import { TextConfig, AttachedFile } from './types';
+interface FollowUpSearchBarProps {
+    initialQuery?: string;
+    onQueryChange: (query: string) => void;
+    isSearching: boolean;
+    handleFollowUpSearch: (query: string) => void;
+    textConfig: TextConfig;
+    enableFileAttachment?: boolean;
+    attachedFiles?: AttachedFile[];
+    isUploading?: boolean;
+    onAddFiles?: (files: File[]) => void;
+    onRemoveFile?: (id: string) => void;
+    disabled?: boolean;
+}
+export declare const FollowUpSearchBar: React.ForwardRefExoticComponent<FollowUpSearchBarProps & React.RefAttributes<HTMLTextAreaElement>>;
+export {};

package/dist/components/chat-search/Header.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+type HeaderProps = React.HTMLAttributes<HTMLDivElement> & {
+    headerText: string;
+    onToggleSizeButtonClick: () => void;
+    onBackButtonClick: () => void;
+    onCloseWidgetClick: () => void;
+    onHistoryButtonClick: () => void;
+    onHistoryBackClick?: () => void;
+    showHistory?: boolean;
+    isSearchWidget?: boolean;
+    hasUnreadConversations?: boolean;
+    showHistoryButton?: boolean;
+};
+export declare function Header({ headerText, onToggleSizeButtonClick, onBackButtonClick, onCloseWidgetClick, isSearchWidget, onHistoryButtonClick, onHistoryBackClick, showHistory, hasUnreadConversations, className, showHistoryButton, ...props }: HeaderProps): React.JSX.Element;
+export {};

package/dist/components/chat-search/HistoryPage.d.ts

@@ -0,0 +1,20 @@
+import { default as React } from 'react';
+import { ConversationSummary } from './types';
+type SelectConversationFn = (params: {
+    conversationId: string;
+    isHandoff: boolean;
+    isCompleted: boolean;
+}) => void;
+type HistoryPageProps = {
+    conversations: ConversationSummary[];
+    isLoading: boolean;
+    onSelectConversation?: SelectConversationFn;
+    botAvatarUrl?: string;
+};
+export declare function ConversationRow({ item, onSelect, botAvatarUrl, }: {
+    item: ConversationSummary;
+    onSelect: SelectConversationFn;
+    botAvatarUrl?: string;
+}): React.JSX.Element;
+export declare function HistoryPage({ conversations, isLoading, onSelectConversation, botAvatarUrl }: HistoryPageProps): React.JSX.Element;
+export {};

package/dist/components/chat-search/IncludePageToggle.d.ts

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+interface IncludePageToggleProps {
+    value: boolean;
+    loading: boolean;
+    disabled: boolean;
+    onToggle: (enabled: boolean) => Promise<void>;
+}
+export declare function IncludePageToggle({ value, loading, disabled, onToggle }: IncludePageToggleProps): React.JSX.Element;
+export {};

package/dist/components/chat-search/KnowledgeGroupSelector.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { KnowledgeSourceGroup } from './types';
+interface KnowledgeGroupSelectorProps {
+    groups: KnowledgeSourceGroup[];
+    onGroupSelect: (group: KnowledgeSourceGroup) => void;
+}
+export declare function KnowledgeGroupSelector({ groups, onGroupSelect }: KnowledgeGroupSelectorProps): React.JSX.Element | null;
+export {};

package/dist/components/chat-search/LoadingConversation.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const LoadingConversation: () => React.JSX.Element;

package/dist/components/chat-search/LoadingSkeleton.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+interface LoadingSkeletonProps {
+    loadingText?: string;
+}
+export declare function LoadingSkeleton({ loadingText }: LoadingSkeletonProps): React.JSX.Element;
+export {};

package/dist/components/chat-search/NextBestActions.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { NextBestAction } from './types';
+interface NextBestActionsProps {
+    nextBestActions: NextBestAction[];
+    onActionClick: (action: NextBestAction, success?: boolean) => void;
+}
+declare const NextBestActions: React.FC<NextBestActionsProps>;
+export { NextBestActions };

package/dist/components/chat-search/PrimarySearch.d.ts

@@ -0,0 +1,38 @@
+import { default as React } from 'react';
+import { Collection, Suggestion, AttachedFile } from './types';
+export declare const PrimarySearch: React.ForwardRefExoticComponent<{
+    query: string;
+    onQueryChange: (query: string) => void;
+    onSearch: () => void;
+    textConfig: {
+        searchPlaceholder?: string;
+        attachImageText?: string;
+        allDocumentsText?: string;
+    };
+    collections?: Collection[];
+    currentCollectionId?: string;
+    onCollectionChange?: (collectionId: string) => void;
+    allowedRegions?: string[];
+    currentRegion?: string;
+    onRegionChange?: (region: string) => void;
+    apiKey?: string;
+    fetchRegionConfig?: (apiKey: string, region: string) => Promise<{
+        settings?: {
+            collections?: Collection[];
+        };
+    } | null>;
+    enableFileAttachment?: boolean;
+    attachedFiles?: AttachedFile[];
+    isUploading?: boolean;
+    onAddFiles?: (files: File[]) => void;
+    onRemoveFile?: (id: string) => void;
+    isSearching?: boolean;
+    autocompleteSuggestions?: Suggestion[];
+    onAutocompleteSuggestionSelect?: (suggestion: Suggestion) => void;
+    isAgentAssist?: boolean;
+    includePageEnabled?: boolean;
+    includePageLoading?: boolean;
+    includePageDisabled?: boolean;
+    onIncludePageToggle?: (enabled: boolean) => Promise<void>;
+} & React.RefAttributes<HTMLTextAreaElement>>;
+export default PrimarySearch;

package/dist/components/chat-search/ResolvedConversationFooter.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+type ResolvedConversationFooterProps = {
+    onStartNewConversation: () => void;
+    message?: string;
+};
+export declare function ResolvedConversationFooter({ onStartNewConversation, message, }: ResolvedConversationFooterProps): React.JSX.Element;
+export {};

package/dist/components/chat-search/Suggestions.d.ts

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+import { Suggestion } from './types';
+interface SuggestionsProps {
+    suggestions: Suggestion[];
+    onQuestionClick: (suggestion: Suggestion) => void;
+    title?: string;
+}
+export declare function Suggestions({ suggestions, onQuestionClick, title }: SuggestionsProps): React.JSX.Element | null;
+export default Suggestions;

package/dist/components/chat-search/TimelineNavigation.d.ts

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+interface TimelineNavigationProps {
+    questions: string[];
+    activeIndex: number;
+    onNavigate: (index: number) => void;
+    offset: number;
+}
+export declare function TimelineNavigation({ questions, activeIndex, onNavigate, offset }: TimelineNavigationProps): React.JSX.Element;
+export {};

package/dist/components/chat-search/ToastContainer.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+import { Toast } from './hooks/useToast';
+export declare function ToastContainer({ toasts, onDismiss }: {
+    toasts: Toast[];
+    onDismiss: (id: number) => void;
+}): React.JSX.Element;

package/dist/components/chat-search/blocks/ActionButtons.d.ts

@@ -0,0 +1,5 @@
+import { ActionButtonsBlock as ActionButtonsBlockType } from '../types';
+export declare function ActionButtonsBlock({ block: _block }: {
+    block: ActionButtonsBlockType;
+}): null;
+export default ActionButtonsBlock;

package/dist/components/chat-search/blocks/ActionInputForm.d.ts

@@ -0,0 +1,20 @@
+import { default as React } from 'react';
+import { ActionInputFormBlock, ActionInputsSchema } from '../types';
+export interface ActionInputFormBlockProps {
+    block: ActionInputFormBlock;
+}
+/**
+ * Patches the schema for AJV resolver to correctly validate required string fields.
+ *
+ * This function addresses a limitation in AJV validation:
+ * By default, AJV only checks if a field exists but doesn't consider empty strings invalid.
+ * For form validation, we need to ensure required string fields are non-empty.
+ * This function adds `minLength: 1` to all required string fields that don't already
+ * have a minLength constraint, ensuring empty strings fail validation.
+ * see https://github.com/react-hook-form/resolvers/blob/master/README.md#ajv
+ *
+ * @param schema - The original JSON schema to enhance
+ * @returns A new schema with minLength constraints added to required string fields
+ */
+export declare function patchSchemaForAjvResolver(schema: ActionInputsSchema): ActionInputsSchema;
+export declare function ActionInputFormBlock({ block }: ActionInputFormBlockProps): React.JSX.Element;

package/dist/components/chat-search/blocks/MarkdownText.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { MarkdownTextBlock, RedirectRule, AnswerState } from '../types';
+export interface MarkdownTextBlockProps {
+    block: MarkdownTextBlock;
+    redirectRules?: RedirectRule[];
+    state: AnswerState;
+}
+export declare function MarkdownTextBlock({ block, redirectRules, state }: MarkdownTextBlockProps): React.JSX.Element | null;

package/dist/components/chat-search/blocks/utils.d.ts

@@ -0,0 +1,16 @@
+import { ActionButtonsBlock, ActionInputFormBlock, ActionInputs, ActionInput, AnswerBlock, MarkdownTextBlock, ActionInputsSchema } from '../types';
+export declare const markdownTextBlock: ({ text }?: {
+    text?: string;
+}) => MarkdownTextBlock;
+export declare const actionInputFormBlock: ({ actionId, initialValues, onSubmit, inputs, schema, }: {
+    actionId: string;
+    initialValues: ActionInputs;
+    onSubmit: (inputs: ActionInputs) => void;
+    inputs: ActionInput[];
+    schema: ActionInputsSchema;
+}) => ActionInputFormBlock;
+export declare const actionButtonsBlock: () => ActionButtonsBlock;
+export declare const isMarkdownTextBlock: (block: AnswerBlock) => block is MarkdownTextBlock;
+export declare const blocksToPlainText: (blocks: AnswerBlock[]) => string;
+export declare const isActionInputFormBlock: (block: AnswerBlock) => block is ActionInputFormBlock;
+export declare const isActionButtonsBlock: (block: AnswerBlock) => block is ActionButtonsBlock;

package/dist/components/chat-search/helpers/buildConversationContext.d.ts

@@ -0,0 +1,2 @@
+import { Answer, ConversationContext } from '../types';
+export declare const buildConversationContext: (answers: Answer[], conversationId?: string) => ConversationContext;

package/dist/components/chat-search/helpers/cancelStreamReader.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Cancels and releases a ReadableStreamDefaultReader to prevent resource leaks.
+ * This utility handles the cancellation and lock release with proper error handling.
+ *
+ * @param reader - The stream reader to cancel and release
+ */
+export declare function cancelStreamReader(reader: ReadableStreamDefaultReader<Uint8Array>): void;

package/dist/components/chat-search/helpers/excuteClientAction.d.ts

@@ -0,0 +1,9 @@
+type ClientActionExecutionResult = {
+    success: true;
+    data: Record<string, any>;
+} | {
+    reason: string;
+    success: false;
+};
+export declare const executeClientAction: (key: string, inputs: Record<string, any>) => Promise<ClientActionExecutionResult>;
+export {};

package/dist/components/chat-search/helpers/initialAiMessage.d.ts

@@ -0,0 +1,2 @@
+export declare const shouldShowInitialGreeting: (message: string | undefined, isLoadedConversation: boolean) => boolean;
+export declare const shouldUseConversationLayout: (message: string | undefined, conversationId: string | undefined, answerCount: number) => boolean;

package/dist/components/chat-search/helpers/nextBestActions.d.ts

@@ -0,0 +1,7 @@
+import { NextBestActionType, Action } from '../types';
+export declare const getActionMapping: (action: Action) => {
+    type: NextBestActionType;
+    icon: string;
+    getValue: (action: any) => string;
+    getLabel: (action: any) => string;
+};

package/dist/components/chat-search/helpers/preChatFormForWidget.d.ts

@@ -0,0 +1,6 @@
+export declare function preChatFormForWidget(value: unknown): {
+    id: string;
+    label: string;
+    type: string;
+    helpText?: string;
+}[];

package/dist/components/chat-search/hooks/index.d.ts

@@ -0,0 +1,10 @@
+export { useIsChatSearchDirty } from './useIsChatSearchDirty';
+export { useScrollManager } from './useScrollManager';
+export { useUrlManager } from './useUrlManager';
+export { useConversationLoader } from './useConversationLoader';
+export { useSubscriptionManager } from './useSubscriptionManager';
+export { useDarkMode } from './useDarkMode';
+export { useAccessibleColor } from './useAccessibleColor';
+export { useIncludePage } from './useIncludePage';
+export { useFileAttachment } from './useFileAttachment';
+export { useToast } from './useToast';

package/dist/components/chat-search/hooks/useAccessibleColor.d.ts

@@ -0,0 +1 @@
+export declare const useAccessibleColor: (primaryColorVar: string, primaryForegroundVar: string) => string;