@inkeep/cxkit-types 0.5.6 → 0.5.8

package/dist/index.d.ts

@@ -2,18 +2,6 @@ import { ComponentType } from 'react';
 import { HTMLProps } from 'react';
 import { ReactNode } from 'react';
 
-export declare interface AIChatBotResponseReceivedEvent {
-    eventName: 'chat_message_bot_response_received';
-    properties: {
-        messages: Message[];
-        messageId: string;
-        question: string;
-        responseMessage: Message;
-        linksUsedInResponse: SourceItem[];
-        workflowId?: string;
-    };
-}
-
 export declare interface AIChatDisclaimerSettings {
     /**
      * Controls whether the disclaimer message is shown.
@@ -34,6 +22,36 @@ export declare interface AIChatDisclaimerSettings {
     tooltip?: string;
 }
 
+export declare interface AIChatFormButtons {
+    submit: {
+        label?: string;
+        onSubmit: SubmitCallback;
+    };
+    close?: {
+        action: CloseFormAction;
+    };
+}
+
+declare interface AIChatFormDoneButton {
+    label: string;
+    icon?: InkeepCustomIcon;
+    action: CloseFormAction;
+}
+
+export declare interface AIChatFormSettings {
+    heading?: string;
+    description?: string;
+    buttons: AIChatFormButtons;
+    fields: FormField[];
+    successView: AIChatFormSuccessView;
+}
+
+declare interface AIChatFormSuccessView {
+    heading: string;
+    message: string;
+    doneButton: AIChatFormDoneButton;
+}
+
 export declare interface AIChatFunctions {
     /**
      * Programmatically sends a message in the chat.
@@ -52,9 +70,9 @@ export declare interface AIChatFunctions {
     clearChat: () => void;
     /**
      * Displays a form overlay in the chat interface.
-     * @param formConfig Configuration object defining the form's fields and behavior
+     * @param formSettings Configuration object defining the form's fields and behavior
      */
-    openForm: (formConfig: FormConfig) => void;
+    openForm: (formSettings: AIChatFormSettings) => void;
     /**
      * Programmatically sets focus to the chat input field.
      * Useful after programmatic updates or when showing the chat interface.
@@ -62,85 +80,6 @@ export declare interface AIChatFunctions {
     focusInput: () => void;
 }
 
-export declare interface AIChatGetHelpOptionClickedEvent {
-    eventName: 'get_help_option_clicked';
-    properties: {
-        actionType?: ChatActionType;
-        name: string;
-        url?: string;
-        conversationId: string;
-    };
-}
-
-export declare interface AIChatHistoryClearedEvent {
-    eventName: 'chat_history_cleared';
-    properties: {
-        conversationId: string | null;
-    };
-}
-
-export declare interface AIChatMessageCopiedEvent {
-    eventName: 'chat_message_copied';
-    properties: {
-        messageId: string;
-    };
-}
-
-export declare interface AIChatMessageSubmittedEvent {
-    eventName: 'chat_message_submitted';
-    properties: {
-        messages: Message[];
-        messageId: string;
-        content: string;
-        workflowId?: string;
-    };
-}
-
-export declare interface AIChatResponseLinkOpenedEvent {
-    eventName: 'chat_response_link_opened';
-    properties: {
-        messageId: string;
-        title?: string;
-        url?: string;
-    };
-}
-
-export declare interface AIChatResponseSourceItemClickedEvent {
-    eventName: 'chat_response_source_item_clicked';
-    properties: {
-        messageId: string;
-        sourceType: SourceItem['type'];
-        title?: string;
-        url?: string;
-    };
-}
-
-export declare interface AIChatShareButtonClickedEvent {
-    eventName: 'chat_share_button_clicked';
-    properties: {
-        sharedChatUrl: string;
-        sharedConversationId: string;
-        originalConversationId: string;
-    };
-}
-
-export declare interface AIChatSharedSessionLoadedEvent {
-    eventName: 'chat_shared_session_loaded';
-    properties: {
-        conversationId: string;
-    };
-}
-
-export declare interface AIChatThumbsDownFeedbackSubmittedEvent {
-    eventName: 'chat_thumbs_down_feedback_submitted';
-    properties: FeedbackProperties;
-}
-
-export declare interface AIChatThumbsUpFeedbackSubmittedEvent {
-    eventName: 'chat_thumbs_up_feedback_submitted';
-    properties: FeedbackProperties;
-}
-
 export declare interface AIChatToolbarButtonLabels {
     /**
      * Text shown on the button that clears the chat history.
@@ -169,25 +108,62 @@ export declare interface AIChatToolbarButtonLabels {
     copyChat?: string;
 }
 
-export declare interface AIChatToolCallActionClickedEvent {
-    eventName: 'toolcall_action_clicked';
+export declare type AnswerConfidence = 'very_confident' | 'somewhat_confident' | 'not_confident' | 'no_sources' | 'other';
+
+export declare interface AssistantCodeBlockCopiedEvent {
+    eventName: 'assistant_code_block_copied';
     properties: {
-        actionType: ChatActionType;
-        conversationId: string;
-        question?: string;
-        answer?: string;
-        answerId?: string;
-        workflowId?: string;
+        conversation: ConversationResponse;
+        language: string;
+        code: string;
     };
 }
 
-export declare type AnswerConfidence = 'very_confident' | 'somewhat_confident' | 'not_confident' | 'no_sources' | 'other';
-
 export declare interface AssistantMessage extends MessageBase {
     role: 'assistant';
     links: SourceItem[];
 }
 
+export declare interface AssistantMessageCopiedEvent {
+    eventName: 'assistant_message_copied';
+    properties: {
+        conversation: ConversationResponse;
+    };
+}
+
+export declare interface AssistantMessageLinkOpenedEvent {
+    eventName: 'assistant_message_inline_link_opened';
+    properties: {
+        title?: string;
+        url?: string;
+    };
+}
+
+export declare interface AssistantMessageReceivedEvent {
+    eventName: 'assistant_message_received';
+    properties: {
+        conversation?: ConversationResponse;
+    };
+}
+
+export declare interface AssistantNegativeFeedbackSubmittedEvent {
+    eventName: 'assistant_positive_feedback_submitted';
+    properties: FeedbackProperties;
+}
+
+export declare interface AssistantPositiveFeedbackSubmittedEvent {
+    eventName: 'assistant_negative_feedback_submitted';
+    properties: FeedbackProperties;
+}
+
+export declare interface AssistantSourceItemClickedEvent {
+    eventName: 'assistant_source_item_clicked';
+    properties: {
+        conversation: ConversationResponse;
+        link: TransformedSource;
+    };
+}
+
 export declare type AvailableBuiltInIcons = 'FaBook' | 'FaGithub' | 'FaDatabase' | 'FaStackOverflow' | 'FaChrome' | 'FaPhone' | 'FaEnvelope' | 'FaPencil' | 'FaBlog' | 'FaSort' | 'FaPenSquare' | 'FaChevronRight' | 'FaChevronUp' | 'FaFilePdf' | 'FaDiscourse' | 'FaDiscord' | 'FaSlack' | 'IoDocumentTextSharp' | 'IoDocumentSharp' | 'IoSend' | 'IoInformationCircleOutline' | 'IoLinkOutline' | 'IoThumbsUpSharp' | 'IoThumbsDownSharp' | 'IoSearch' | 'IoCopyOutline' | 'IoCopy' | 'IoReturnDownBackOutline' | 'IoChevronForwardOutline' | 'IoReturnDownForward' | 'IoCloseOutline' | 'IoCheckmarkOutline' | 'IoBookOutline' | 'IoReaderOutline' | 'IoHelpBuoyOutline' | 'IoPeopleOutline' | 'IoDocumentTextOutline' | 'IoChatbubblesOutline' | 'FaRegFilePdf' | 'IoLogoDiscord' | 'IoLogoGithub' | 'IoTerminal' | 'FaBriefcase' | 'IoPlayCircleOutline' | 'IoPencilOutline' | 'IoCheckmarkDoneOutline' | 'IoHomeOutline' | 'IoMail' | 'IoOpenOutline' | 'FaTelegram' | 'FaTable' | 'FaMagnifyingGlass' | 'LuArrowLeft' | 'LuCircleCheck' | 'LuCommand' | 'LuCopy' | 'LuCheck' | 'LuCornerDownLeft' | 'LuRepeat' | 'LuThumbsDown' | 'LuThumbsUp' | 'LuUsers' | 'LuUser' | 'LuArrowUpRight' | 'LuBookOpen' | 'LuChevronDown' | 'LuLoaderCircle' | 'FiEdit' | 'LuSparkles';
 
 export declare interface BaseFormField {
@@ -202,7 +178,14 @@ declare type ChatAction = InvokeCallbackAction | OpenFormAction | OpenUrlAction;
 
 export declare type ChatActionType = ChatAction['type'];
 
-export declare type ChatEvent = AIChatBotResponseReceivedEvent | AIChatMessageSubmittedEvent | AIChatSharedSessionLoadedEvent | AIChatThumbsDownFeedbackSubmittedEvent | AIChatThumbsUpFeedbackSubmittedEvent | AIChatHistoryClearedEvent | AIChatMessageCopiedEvent | AIChatGetHelpOptionClickedEvent | AIChatToolCallActionClickedEvent | AIChatShareButtonClickedEvent | AIChatResponseSourceItemClickedEvent | AIChatResponseLinkOpenedEvent | CodeBlockCopiedEvent;
+export declare interface ChatClearButtonClickedEvent {
+    eventName: 'chat_clear_button_clicked';
+    properties: {
+        conversation: ConversationResponse;
+    };
+}
+
+export declare type ChatEvent = AssistantMessageReceivedEvent | UserMessageSubmittedEvent | SharedChatLoadedEvent | AssistantPositiveFeedbackSubmittedEvent | AssistantNegativeFeedbackSubmittedEvent | ChatClearButtonClickedEvent | AssistantMessageCopiedEvent | GetHelpOptionClickedEvent | ChatShareButtonClickedEvent | AssistantSourceItemClickedEvent | AssistantMessageLinkOpenedEvent | AssistantCodeBlockCopiedEvent;
 
 export declare enum ChatModel {
     /**
@@ -212,26 +195,23 @@ export declare enum ChatModel {
     QA_EXPERT = "inkeep-qa-expert"
 }
 
+export declare interface ChatShareButtonClickedEvent {
+    eventName: 'chat_share_button_clicked';
+    properties: {
+        sharedChatUrl: string;
+        sharedConversationId: string;
+        originalConversationId: string;
+        conversation: ConversationResponse;
+    };
+}
+
 declare interface CheckboxField extends BaseFormField {
     inputType: 'checkbox';
     defaultValue?: boolean;
 }
 
-export declare interface Client {
-    currentUrl: string;
-}
-
 export declare type CloseFormAction = 'return_to_chat' | 'close_modal';
 
-export declare interface CodeBlockCopiedEvent {
-    eventName: 'chat_code_block_copied';
-    properties: {
-        conversationId: string;
-        language: string;
-        code: string;
-    };
-}
-
 export declare interface ColorMode extends Omit<ColorModeProviderProps, 'children' | 'rootId' | 'shadowHostId'> {
     /**
      * Configuration for syncing the widget's color mode with an external element.
@@ -285,7 +265,7 @@ export declare interface ColorModeProviderProps {
 }
 
 declare interface CommonProperties {
-    conversationId: string;
+    conversation: ConversationResponse;
     componentType: any;
     tags: string[];
 }
@@ -306,7 +286,10 @@ export declare interface ConversationMessage {
     createdAt: string;
     updatedAt: string;
     role: 'assistant' | 'system' | 'user';
-    content: string;
+    content: string | {
+        type: 'text';
+        text: string;
+    }[];
     name: string;
     links: SourceItem[];
     properties: Record<string, unknown>;
@@ -385,12 +368,8 @@ export declare interface FeedbackBody {
 export declare type FeedbackItemType = keyof MessageFeedback;
 
 declare interface FeedbackProperties {
-    conversationId: string;
-    messageId: string;
-    question: string;
-    answer: string;
+    conversation?: ConversationResponse;
     reasons: FeebackReason[];
-    workflowId?: string;
 }
 
 export declare type FeedbackType = 'positive' | 'negative';
@@ -401,24 +380,6 @@ declare interface FileField extends BaseFormField {
     inputType: 'file';
 }
 
-export declare interface FormButtons {
-    submit: {
-        label?: string;
-        onSubmit: SubmitCallback;
-    };
-    close?: {
-        action: CloseFormAction;
-    };
-}
-
-export declare interface FormConfig {
-    heading?: string;
-    description?: string;
-    buttons: FormButtons;
-    fields: FormField[];
-    successView: SuccessView;
-}
-
 export declare type FormField = CheckboxField | FileField | SelectField | TextField | IncludeChatSessionField;
 
 export declare type FormInputType = NonNullable<FormField['inputType']>;
@@ -430,6 +391,14 @@ export declare interface GetHelpOption {
     action: ChatAction;
 }
 
+export declare interface GetHelpOptionClickedEvent {
+    eventName: 'get_help_option_clicked';
+    properties: {
+        getHelpOption: GetHelpOption;
+        conversation?: ConversationResponse;
+    };
+}
+
 export declare enum GitHubIssueState {
     Closed = "CLOSED",
     Open = "OPEN"
@@ -449,7 +418,7 @@ export declare interface IncludeChatSessionField extends BaseFormField {
     defaultValue?: boolean;
 }
 
-export declare interface InkeepAIChatSettings extends ToolConfig {
+export declare interface InkeepAIChatSettings {
     /**
      * The placeholder text to display in the chat input field when empty.
      * Use this to provide guidance on what kind of questions users can ask.
@@ -840,15 +809,39 @@ export declare interface InkeepSearchSettings {
 
 export declare type InputMaybe<T> = T | null;
 
-export declare interface IntelligentFormAIErrorEvent {
-    eventName: 'intelligent_form_ai_error';
+export declare interface IntelligentFormAIResponseProvidedEvent {
+    eventName: 'intelligent_form_ai_response_provided';
+    properties: {
+        conversation?: ConversationResponse;
+        recordsConsidered?: SourceItem[];
+    };
+}
+
+export declare interface IntelligentFormButtons {
+    /** Callback function called when form is submitted */
+    submit: {
+        label?: string;
+        onSubmit: SubmitCallback;
+    };
+}
+
+export declare type IntelligentFormEvent = IntelligentFormPrimarySectionSubmittedEvent | IntelligentFormAIResponseProvidedEvent | IntelligentFormSubmittedEvent;
+
+export declare type IntelligentFormField = Exclude<FormField, IncludeChatSessionField> & {
+    /**
+     * Controls whether to prefill the field with the AI's response
+     */
+    shouldPrefillWithAI?: boolean;
+};
+
+export declare interface IntelligentFormPrimarySectionSubmittedEvent {
+    eventName: 'intelligent_form_primary_section_submitted';
     properties: {
-        conversationId: string;
-        error: string;
+        conversation?: ConversationResponse;
     };
 }
 
-export declare interface IntelligentFormConfig {
+export declare interface IntelligentFormSettings {
     /**
      * Primary form section that is always shown
      */
@@ -878,61 +871,16 @@ export declare interface IntelligentFormConfig {
     };
     /** Configuration for the success view shown after form submission */
     successView: IntelligentFormSuccessView;
-    /** Callback function called when form is submitted */
-    onSubmit: SubmitCallback;
+    /** Configuration for the buttons shown in the form */
+    buttons: IntelligentFormButtons;
     /** Optional name of the assistant shown in the form */
     aiAssistantName?: string;
 }
 
-export declare interface IntelligentFormContextSuggestionsEvent {
-    eventName: 'intelligent_form_context_suggestions';
-    properties: {
-        conversationId: string;
-        suggestedFields: string[];
-    };
-}
-
-export declare type IntelligentFormEvent = IntelligentFormSubmittedEvent | IntelligentFormSubmissionErrorEvent | IntelligentFormPrimarySubmittedEvent | IntelligentFormQAResponseEvent | IntelligentFormContextSuggestionsEvent | IntelligentFormAIErrorEvent;
-
-export declare type IntelligentFormField = Exclude<FormField, IncludeChatSessionField> & {
-    /**
-     * Controls whether to prefill the field with the AI's response
-     */
-    shouldPrefillWithAI?: boolean;
-};
-
-export declare interface IntelligentFormPrimarySubmittedEvent {
-    eventName: 'intelligent_form_primary_submitted';
-    properties: {
-        conversationId: string;
-        fields: string[];
-        messages: Message[];
-    };
-}
-
-export declare interface IntelligentFormQAResponseEvent {
-    eventName: 'intelligent_form_qa_response';
-    properties: {
-        conversationId: string;
-        messages: Message[];
-        answer: string;
-        confidence?: AnswerConfidence;
-        recordsConsidered?: SourceItem[];
-    };
-}
-
-export declare interface IntelligentFormSubmissionErrorEvent {
-    eventName: 'intelligent_form_submission_error';
-    properties: {
-        conversationId: string;
-        error: string;
-    };
-}
-
 export declare interface IntelligentFormSubmittedEvent {
     eventName: 'intelligent_form_submitted';
     properties: {
-        conversationId: string;
+        conversation: ConversationResponse;
         values: Record<string, unknown>;
     };
 }
@@ -976,16 +924,11 @@ export declare interface MessageAttributes {
 }
 
 declare interface MessageBase {
-    content: MessageContent;
+    content: ConversationResponse['messages'][number]['content'];
     id: string;
     metadata?: MessageMetadata;
 }
 
-export declare type MessageContent = string | {
-    type: 'text';
-    text: string;
-}[];
-
 export declare interface MessageFeedback {
     unrelated_response: boolean;
     inaccurate_statement: boolean;
@@ -1008,7 +951,7 @@ export declare type OnToggleView = (opts: {
 
 export declare interface OpenFormAction {
     type: 'open_form';
-    formConfig: FormConfig;
+    formSettings: AIChatFormSettings;
 }
 
 export declare interface OpenUrlAction {
@@ -1085,7 +1028,7 @@ export declare interface SearchQueryResponseReceivedEvent {
     eventName: 'search_query_response_received';
     properties: {
         searchQuery: string;
-        totalHits: number;
+        totalResults: number;
     };
 }
 
@@ -1149,6 +1092,13 @@ export declare interface ShadowRootProps {
     children?: ReactNode;
 }
 
+export declare interface SharedChatLoadedEvent {
+    eventName: 'shared_chat_loaded';
+    properties: {
+        conversation?: ConversationResponse;
+    };
+}
+
 export declare interface SourceItem {
     id?: string;
     title: string | undefined;
@@ -1233,19 +1183,6 @@ export declare type SubmitCallback = (values: SubmitCallbackArgs) => Promise<voi
 export declare interface SubmitCallbackArgs {
     values: FieldValues;
     conversation: ConversationResponse | null;
-    client: Client;
-}
-
-declare interface SuccessView {
-    heading: string;
-    message: string;
-    button: SuccessViewButton;
-}
-
-declare interface SuccessViewButton {
-    label: string;
-    icon?: InkeepCustomIcon;
-    action: CloseFormAction;
 }
 
 export declare interface SyncColorMode {
@@ -1506,6 +1443,13 @@ export declare interface UserMessage extends MessageBase {
     role: 'user';
 }
 
+export declare interface UserMessageSubmittedEvent {
+    eventName: 'user_message_submitted';
+    properties: {
+        conversation?: ConversationResponse;
+    };
+}
+
 export declare interface UserProperties {
     /**
      * The user ID.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkeep/cxkit-types",
-  "version": "0.5.6",
+  "version": "0.5.8",
   "description": "",
   "license": "Inkeep, Inc. Customer License (IICL) v1.1",
   "homepage": "",