@brainfish-ai/components 0.35.20 → 0.36.1

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

@@ -0,0 +1,253 @@
+import { ImmerReducer } from 'use-immer';
+import { ActionInputs, ActionInput, Answer, AnswerAttachment, AnswerBlock, FeedbackResponse, JSONSchema, SearchResult } from '../types';
+export declare const AnswersActions: {
+    readonly SET_ANSWERS: "answers/set_answers";
+    readonly CLEAR_ALL: "answers/clear_all";
+    readonly APPEND_NEW_ANSWER: "answers/create_empty_answer";
+    readonly APPEND_BLOCK: "answers/append_block";
+    readonly APPEND_ANSWER_CHUNK: "answers/append_stream_chunk";
+    readonly SET_SEARCH_RESULTS: "answers/update_search_results";
+    readonly SET_FOLLOW_UP_QUESTIONS: "answers/set_follow_up_questions";
+    readonly COMPLETE_ANSWER: "answers/finish_streaming";
+    readonly SET_ANSWER_ERROR: "answers/set_error_state";
+    readonly SET_USER_FEEDBACK: "answers/set_user_feedback";
+    readonly CLEAR_USER_FEEDBACK: "answers/clear_user_feedback";
+    readonly MARK_AS_UNCERTAIN: "answers/mark_as_uncertain";
+    readonly NO_ARTICLES_FOUND: "answers/no_articles_found";
+    readonly GET_ACTION_INPUTS: "answers/request_action_inputs";
+    readonly INVOKE_ACTION: "answers/invoke_action";
+    readonly ADD_ACTION_BUTTONS: "answers/add_action_buttons";
+    readonly SET_AWAITING_KNOWLEDGE_GROUP: "answers/set_awaiting_knowledge_group";
+    readonly SET_KNOWLEDGE_GROUP_SELECTED: "answers/set_knowledge_group_selected";
+    readonly SET_STATUS_MESSAGE: "answers/set_status_message";
+};
+type SetAnswers = {
+    type: typeof AnswersActions.SET_ANSWERS;
+    payload: {
+        answers: Answer[];
+    };
+};
+type ClearAll = {
+    type: typeof AnswersActions.CLEAR_ALL;
+};
+type AppendNewAnswer = {
+    type: typeof AnswersActions.APPEND_NEW_ANSWER;
+    payload: {
+        id?: string;
+        query: string;
+        attachments?: AnswerAttachment[];
+    };
+};
+type SetSearchResults = {
+    type: typeof AnswersActions.SET_SEARCH_RESULTS;
+    payload: {
+        searchQueryId: string;
+        results: SearchResult[];
+        index?: number;
+        state?: Answer['state'];
+    };
+};
+type AppendAnswerChunk = {
+    type: typeof AnswersActions.APPEND_ANSWER_CHUNK;
+    payload: {
+        text: string;
+        index?: number;
+    };
+};
+type SetAnswerError = {
+    type: typeof AnswersActions.SET_ANSWER_ERROR;
+    payload: {
+        error: string;
+        index?: number;
+    };
+};
+type SetUserFeedback = {
+    type: typeof AnswersActions.SET_USER_FEEDBACK;
+    payload: {
+        feedback: FeedbackResponse;
+        index?: number;
+    };
+};
+type ClearUserFeedback = {
+    type: typeof AnswersActions.CLEAR_USER_FEEDBACK;
+    payload: {
+        index?: number;
+    };
+};
+type SetFollowUpQuestions = {
+    type: typeof AnswersActions.SET_FOLLOW_UP_QUESTIONS;
+    payload: {
+        questions: string[];
+        index?: number;
+    };
+};
+type AppendBlock = {
+    type: typeof AnswersActions.APPEND_BLOCK;
+    payload: {
+        block: AnswerBlock;
+        index?: number;
+    };
+};
+type CompleteAnswer = {
+    type: typeof AnswersActions.COMPLETE_ANSWER;
+    payload: {
+        index?: number;
+    };
+};
+type MarkAsUncertain = {
+    type: typeof AnswersActions.MARK_AS_UNCERTAIN;
+    payload: {
+        uncertaintyText: string;
+        index?: number;
+    };
+};
+type GetActionInputs = {
+    type: typeof AnswersActions.GET_ACTION_INPUTS;
+    payload: {
+        searchIntentId: string;
+        actionId: string;
+        inputs: ActionInput[];
+        schema: JSONSchema<ActionInputs>;
+        initialValues: ActionInputs;
+        onSubmit: (parameters: ActionInputs) => void;
+        index?: number;
+    };
+};
+type AddActionButtons = {
+    type: typeof AnswersActions.ADD_ACTION_BUTTONS;
+    payload: {
+        searchIntentId: string;
+        actions: Array<{
+            id: string;
+            type: string;
+            action: {
+                version: string;
+                options: {
+                    title?: string;
+                    [key: string]: any;
+                };
+            };
+        }>;
+        index?: number;
+    };
+};
+type InvokeAction = {
+    type: typeof AnswersActions.INVOKE_ACTION;
+    payload: {
+        index?: number;
+    };
+};
+type NoArticlesFound = {
+    type: typeof AnswersActions.NO_ARTICLES_FOUND;
+    payload: {
+        index?: number;
+    };
+};
+type SetAwaitingKnowledgeGroup = {
+    type: typeof AnswersActions.SET_AWAITING_KNOWLEDGE_GROUP;
+    payload: {
+        index?: number;
+    };
+};
+type SetKnowledgeGroupSelected = {
+    type: typeof AnswersActions.SET_KNOWLEDGE_GROUP_SELECTED;
+    payload: {
+        index?: number;
+    };
+};
+type SetStatusMessage = {
+    type: typeof AnswersActions.SET_STATUS_MESSAGE;
+    payload: {
+        message: string;
+        index?: number;
+    };
+};
+export type AnswerListAction = SetAnswers | ClearAll | AppendNewAnswer | SetSearchResults | AppendAnswerChunk | SetAnswerError | SetUserFeedback | ClearUserFeedback | SetFollowUpQuestions | AppendBlock | CompleteAnswer | MarkAsUncertain | InvokeAction | GetActionInputs | AddActionButtons | NoArticlesFound | SetAwaitingKnowledgeGroup | SetKnowledgeGroupSelected | SetStatusMessage;
+export declare const setAnswers: ({ answers }: {
+    answers: Answer[];
+}) => SetAnswers;
+export declare const clearAll: () => ClearAll;
+export declare const appendNewAnswer: ({ id, query, attachments, }: {
+    id?: string;
+    query: string;
+    attachments?: AnswerAttachment[];
+}) => AppendNewAnswer;
+export declare const setSearchResults: ({ searchQueryId, results, index, state, }: {
+    searchQueryId: string;
+    results: SearchResult[];
+    index?: number;
+    state?: Answer["state"];
+}) => SetSearchResults;
+export declare const appendAnswerChunk: ({ text, index }: {
+    text: string;
+    index?: number;
+}) => AppendAnswerChunk;
+export declare const setAnswerError: ({ error, index }: {
+    error: string;
+    index?: number;
+}) => SetAnswerError;
+export declare const setUserFeedback: ({ feedback, index }: {
+    feedback: FeedbackResponse;
+    index?: number;
+}) => SetUserFeedback;
+export declare const clearUserFeedback: ({ index }?: {
+    index?: number;
+}) => ClearUserFeedback;
+export declare const setFollowUpQuestions: ({ questions, index }: {
+    questions: string[];
+    index?: number;
+}) => SetFollowUpQuestions;
+export declare const appendBlock: ({ block, index }: {
+    block: AnswerBlock;
+    index?: number;
+}) => AppendBlock;
+export declare const completeAnswer: ({ index }?: {
+    index?: number;
+}) => CompleteAnswer;
+export declare const markAsUncertain: ({ uncertaintyText, index }: {
+    uncertaintyText: string;
+    index?: number;
+}) => MarkAsUncertain;
+export declare const invokeAction: ({ index }?: {
+    index?: number;
+}) => InvokeAction;
+export declare const noArticlesFound: ({ index }?: {
+    index?: number;
+}) => NoArticlesFound;
+export declare const setAwaitingKnowledgeGroup: ({ index }?: {
+    index?: number;
+}) => SetAwaitingKnowledgeGroup;
+export declare const setKnowledgeGroupSelected: ({ index }?: {
+    index?: number;
+}) => SetKnowledgeGroupSelected;
+export declare const setStatusMessage: ({ message, index }: {
+    message: string;
+    index?: number;
+}) => SetStatusMessage;
+export declare const getActionInputs: ({ searchIntentId, actionId, inputs, schema, initialValues, onSubmit, index, }: {
+    searchIntentId: string;
+    actionId: string;
+    inputs: ActionInput[];
+    schema: JSONSchema<ActionInputs>;
+    initialValues: ActionInputs;
+    onSubmit: (parameters: ActionInputs) => void;
+    index?: number;
+}) => GetActionInputs;
+export declare const addActionButtons: ({ searchIntentId, actions, index, }: {
+    searchIntentId: string;
+    actions: Array<{
+        id: string;
+        type: string;
+        action: {
+            version: string;
+            options: {
+                title?: string;
+                [key: string]: any;
+            };
+        };
+    }>;
+    index?: number;
+}) => AddActionButtons;
+export declare const answerListReducer: ImmerReducer<Answer[], AnswerListAction>;
+export declare const useAnswerList: () => [Answer[], import('react').Dispatch<AnswerListAction>];
+export {};

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

@@ -0,0 +1,32 @@
+import { ConversationSummary } from '../types';
+interface UseConversationHistoryParams {
+    enabled?: boolean;
+    conversationHistoryEndpoint?: string;
+    markConversationReadEndpoint?: string;
+    markConversationCompletedEndpoint?: string;
+    headers?: Record<string, string>;
+    userData?: {
+        userId?: string | number;
+    };
+    currentConversationId: string | undefined;
+    loadConversationById: (conversationId: string) => void;
+    reconnectHandoff?: (conversationId: string) => void;
+    resetHandoff?: () => void;
+}
+export declare function useConversationHistory({ enabled, conversationHistoryEndpoint, markConversationReadEndpoint, markConversationCompletedEndpoint, headers, userData, currentConversationId, loadConversationById, reconnectHandoff, resetHandoff, }: UseConversationHistoryParams): {
+    showHistory: boolean;
+    setShowHistory: import('react').Dispatch<import('react').SetStateAction<boolean>>;
+    conversations: ConversationSummary[];
+    isLoadingHistory: boolean;
+    hasUnreadConversations: boolean;
+    isViewOnly: boolean;
+    setIsViewOnly: import('react').Dispatch<import('react').SetStateAction<boolean>>;
+    handleSelectConversation: ({ conversationId, isHandoff, isCompleted }: {
+        conversationId: string;
+        isHandoff: boolean;
+        isCompleted: boolean;
+    }) => void;
+    completeActiveConversations: () => void;
+    refetchConversations: () => void;
+};
+export {};

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

@@ -0,0 +1,5 @@
+export declare const useConversationId: (searchPath?: string, widgetKey?: string) => {
+    conversationId: string | undefined;
+    setConversationId: (id: string) => void;
+    clearConversationId: () => void;
+};

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

@@ -0,0 +1,19 @@
+import { TextConfig } from '../text-config';
+interface UseLoadConversationProps {
+    loadConversationEndpoint: string | undefined;
+    headers?: Record<string, string>;
+    mergedTextConfig: TextConfig;
+    reconnectHandoff?: (conversationId: string) => void;
+    onConversationLoaded?: () => void;
+}
+/**
+ * Hook to load a conversation by ID.
+ * @param loadConversationEndpoint - The endpoint to use to load the conversation.
+ * @param headers - The headers to use when loading the conversation.
+ * @param mergedTextConfig - The text configuration to use.
+ * @returns The function to load a conversation by ID.
+ */
+export declare const useConversationLoader: ({ loadConversationEndpoint, headers, reconnectHandoff, onConversationLoaded, }: UseLoadConversationProps) => {
+    loadConversationById: (id: string) => (() => void) | undefined;
+};
+export {};

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

@@ -0,0 +1 @@
+export declare const useDarkMode: () => boolean;

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

@@ -0,0 +1,20 @@
+import { AttachedFile, AttachmentType } from '../types';
+interface UseFileAttachmentOptions {
+    uploadEndpoint?: string;
+    headers?: Record<string, string>;
+    getConversationId: () => string;
+    onError?: (message: string) => void;
+}
+export declare function useFileAttachment({ uploadEndpoint, headers, getConversationId, onError }: UseFileAttachmentOptions): {
+    attachedFiles: AttachedFile[];
+    isUploading: boolean;
+    addFiles: (files: File[]) => void;
+    removeFile: (id: string) => void;
+    clearAttachedFiles: () => void;
+    getUploadedAttachments: () => {
+        type: AttachmentType;
+        url: string;
+        filename: string;
+    }[];
+};
+export {};

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

@@ -0,0 +1,20 @@
+interface UseIncludePageProps {
+    isAgentAssist?: boolean;
+    apiKey: string;
+    trackEvent?: (eventName: string, data: Record<string, any>) => void;
+}
+/**
+ * Hook to manage "include page" toggle functionality for agent assist mode.
+ * Handles permission requests, page content fetching, and state management.
+ */
+export declare const useIncludePage: ({ isAgentAssist, apiKey, trackEvent }: UseIncludePageProps) => {
+    includePageEnabled: boolean;
+    includePageLoading: boolean;
+    includePageDisabled: boolean;
+    handleIncludePageToggle: (enabled: boolean) => Promise<void>;
+    fetchPageContext: (conversationId?: string, searchQuery?: string) => Promise<{
+        type: "text";
+        text: string;
+    }[] | undefined>;
+};
+export {};

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

@@ -0,0 +1 @@
+export declare const useIsChatSearchDirty: () => boolean;

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

@@ -0,0 +1,6 @@
+import { RefObject } from 'react';
+export declare const useScrollManager: (answerRefs: RefObject<(HTMLDivElement | null)[]>, containerRef: RefObject<HTMLDivElement | null>, bottomRef?: RefObject<HTMLDivElement | null>) => {
+    scrollToLastAnswer: () => void;
+    scrollToAnswer: (index: number) => void;
+    scrollToBottom: () => void;
+};

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

@@ -0,0 +1,4 @@
+import { ChatSearchState } from '../types';
+export declare const useSubscriptionManager: () => {
+    subscribeToStateChanges: (callback: (state: ChatSearchState) => void) => () => void;
+};

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

@@ -0,0 +1,9 @@
+export interface Toast {
+    id: number;
+    message: string;
+}
+export declare function useToast(duration?: number): {
+    toasts: Toast[];
+    showToast: (message: string) => void;
+    dismissToast: (id: number) => void;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * Manages the URL based on the conversation ID and answers.
+ * @param searchPath - The path to use in the URL.
+ */
+export declare const useUrlManager: (searchPath?: string) => {
+    updateUrlWithConversationId: (conversationId: string) => void;
+    removeConversationIdFromUrl: () => void;
+};

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

@@ -0,0 +1,7 @@
+export { default as ChatSearch } from './ChatSearch';
+export { ResolvedConversationFooter } from './ResolvedConversationFooter';
+export type { ChatSearchHandle } from './ChatSearch';
+export type { Answer, ChatSearchProps, Collection, ChatSearchState, ConversationContext, ConversationMessage, KnowledgeSourceGroup, NextBestAction, NextBestActionValue, } from './types';
+export { NextBestActionType, validateUrlString } from './types';
+export { ChatSearchProvider, useChatSearch } from './ChatSearchContext';
+export * from './hooks/useIsChatSearchDirty';

package/dist/components/chat-search/text-config.d.ts

@@ -0,0 +1,3 @@
+import { TextConfig as TextConfigType } from './types';
+export type TextConfig = TextConfigType;
+export declare const defaultTextConfig: TextConfig;

package/dist/components/chat-search/types/messages.d.ts

@@ -0,0 +1,21 @@
+/**
+ * PostMessage types for communication between the widget and Chrome extension
+ */
+export type PagePermissionResponse = {
+    type: 'PAGE_PERMISSION_RESPONSE';
+    requestId: string;
+    granted: boolean;
+    error?: string;
+};
+export type PageContentResponse = {
+    type: 'PAGE_CONTENT_RESPONSE';
+    requestId: string;
+    success: boolean;
+    content?: string;
+    error?: string;
+};
+export type IncludePageStateMessage = {
+    type: 'INCLUDE_PAGE_STATE';
+    enabled: boolean;
+    disabled: boolean;
+};