@inkeep/cxkit-types 0.5.2 → 0.5.4

package/dist/index.d.ts

@@ -2,34 +2,6 @@ import { ComponentType } from 'react';
 import { HTMLProps } from 'react';
 import { ReactNode } from 'react';
 
-export declare interface AIChatActionButtonLabels {
-    /**
-     * Text shown on the button that clears the chat history.
-     * @example "Clear Chat" or "Start Over"
-     */
-    clearButtonLabel?: string;
-    /**
-     * Text shown on the button that generates a shareable chat link.
-     * @example "Share Chat" or "Get Link"
-     */
-    shareButtonLabel?: string;
-    /**
-     * Text shown on the button that opens the help options menu.
-     * @example "Get Help" or "Support Options"
-     */
-    getHelpButtonLabel?: string;
-    /**
-     * Text shown on the button that stops the AI from generating a response.
-     * @example "Stop" or "Cancel Response"
-     */
-    stopButtonLabel?: string;
-    /**
-     * Text shown on the button that copies the chat transcript.
-     * @example "Copy Chat" or "Copy Transcript"
-     */
-    copyChatButtonLabel?: string;
-}
-
 export declare interface AIChatBotResponseReceivedEvent {
     eventName: 'chat_message_bot_response_received';
     properties: {
@@ -48,7 +20,7 @@ export declare interface AIChatDisclaimerSettings {
      * Enable this when you need to display important notices or legal disclaimers.
      * @default false
      */
-    enabled?: boolean;
+    isEnabled?: boolean;
     /**
      * The main text content of the disclaimer message.
      * Should clearly communicate important information about AI usage or limitations.
@@ -169,6 +141,34 @@ export declare interface AIChatThumbsUpFeedbackSubmittedEvent {
     properties: FeedbackProperties;
 }
 
+export declare interface AIChatToolbarButtonLabels {
+    /**
+     * Text shown on the button that clears the chat history.
+     * @example "Clear Chat" or "Start Over"
+     */
+    clear?: string;
+    /**
+     * Text shown on the button that generates a shareable chat link.
+     * @example "Share Chat" or "Get Link"
+     */
+    share?: string;
+    /**
+     * Text shown on the button that opens the help options menu.
+     * @example "Get Help" or "Support Options"
+     */
+    getHelp?: string;
+    /**
+     * Text shown on the button that stops the AI from generating a response.
+     * @example "Stop" or "Cancel Response"
+     */
+    stop?: string;
+    /**
+     * Text shown on the button that copies the chat transcript.
+     * @example "Copy Chat" or "Copy Transcript"
+     */
+    copyChat?: string;
+}
+
 export declare interface AIChatToolCallActionClickedEvent {
     eventName: 'toolcall_action_clicked';
     properties: {
@@ -181,24 +181,6 @@ export declare interface AIChatToolCallActionClickedEvent {
     };
 }
 
-export declare interface Analytics {
-    /**
-     * Whether to opt out of analytical cookies.
-     * @default false
-     */
-    optOutAnalyticalCookies?: boolean;
-    /**
-     * Whether to opt out of all analytics.
-     * @default false
-     */
-    optOutAllAnalytics?: boolean;
-    /**
-     * Whether to opt out of functional cookies.
-     * @default false
-     */
-    optOutFunctionalCookies?: boolean;
-}
-
 export declare type AnswerConfidence = 'very_confident' | 'somewhat_confident' | 'not_confident' | 'no_sources' | 'other';
 
 export declare interface AssistantMessage extends MessageBase {
@@ -211,7 +193,7 @@ export declare type AvailableBuiltInIcons = 'FaBook' | 'FaGithub' | 'FaDatabase'
 export declare interface BaseFormField {
     name: string;
     label: string;
-    required?: boolean;
+    isRequired?: boolean;
     isHidden?: boolean;
     description?: string;
 }
@@ -231,7 +213,7 @@ export declare enum ChatModel {
 }
 
 declare interface CheckboxField extends BaseFormField {
-    inputType: 'CHECKBOX';
+    inputType: 'checkbox';
     defaultValue?: boolean;
 }
 
@@ -239,7 +221,7 @@ export declare interface Client {
     currentUrl: string;
 }
 
-export declare type CloseFormAction = 'BACK_TO_CHAT' | 'CLOSE_MODAL';
+export declare type CloseFormAction = 'return_to_chat' | 'close_modal';
 
 export declare interface CodeBlockCopiedEvent {
     eventName: 'chat_code_block_copied';
@@ -304,7 +286,7 @@ export declare interface ColorModeProviderProps {
 
 declare interface CommonProperties {
     conversationId: string;
-    interactionType: any;
+    componentType: any;
     tags: string[];
 }
 
@@ -416,7 +398,7 @@ export declare type FeedbackType = 'positive' | 'negative';
 export declare type FieldValues = Record<string, any>;
 
 declare interface FileField extends BaseFormField {
-    inputType: 'FILE';
+    inputType: 'file';
 }
 
 export declare interface FormButtons {
@@ -441,10 +423,10 @@ export declare type FormField = CheckboxField | FileField | SelectField | TextFi
 
 export declare type FormInputType = NonNullable<FormField['inputType']>;
 
-export declare interface GetHelpCallToAction {
+export declare interface GetHelpOption {
     icon?: InkeepCustomIcon;
     name: string;
-    pinToToolbar?: boolean;
+    isPinnedToToolbar?: boolean;
     action: ChatAction;
 }
 
@@ -453,7 +435,7 @@ export declare enum GitHubIssueState {
     Open = "OPEN"
 }
 
-export declare type IkpChatAction = GetHelpCallToAction | ToolCallAction;
+export declare type IkpChatAction = GetHelpOption | ToolCallAction;
 
 export declare type IkpTheme = DeepPartial<StrictIkpTheme>;
 
@@ -462,8 +444,8 @@ export declare type IkpThemeCategory = keyof StrictIkpTheme;
 export declare type IkpThemeEntry = [keyof IkpTheme, Record<string, unknown>][];
 
 export declare interface IncludeChatSessionField extends BaseFormField {
-    _type: 'INCLUDE_CHAT_SESSION';
-    inputType?: 'CHECKBOX';
+    _type: 'include_chat_session';
+    inputType?: 'checkbox';
     defaultValue?: boolean;
 }
 
@@ -477,7 +459,7 @@ export declare interface InkeepAIChatSettings extends ToolConfig {
     /**
      * A welcome message shown at the start of a new chat session.
      * Supports markdown formatting for rich text styling.
-     * Use this to introduce the bot's capabilities and set expectations.
+     * Use this to introduce the AI assistant's capabilities and set expectations.
      * @example "👋 Hi! I'm here to help you with technical questions about our API..."
      */
     introMessage?: string;
@@ -493,24 +475,30 @@ export declare interface InkeepAIChatSettings extends ToolConfig {
      * Choose a name that reflects the assistant's role and your brand.
      * @example "Atlas Assistant" or "DevBot"
      */
-    botName?: string;
+    aiAssistantName?: string;
     /**
-     * URL to the bot's avatar image for light mode.
+     * URL to the AI assistant's avatar image.
      * Should be a square image, recommended size 40x40px.
      * Supports common image formats (PNG, JPG, SVG).
+     *
+     * You can pass a string or an object to configure for different color modes.
+     *
+     * @example
+     * {
+     *   light: 'https://example.com/avatar-light.png',
+     *   dark: 'https://example.com/avatar-dark.png',
+     * }
      */
-    botAvatarSrcUrl?: string;
-    /**
-     * URL to the bot's avatar image for dark mode.
-     * Should be a square image, recommended size 40x40px.
-     */
-    botAvatarDarkSrcUrl?: string;
+    aiAssistantAvatar?: string | {
+        light: string;
+        dark: string;
+    };
     /**
      * URL to the user's avatar image in the chat interface.
      * Should be a square image, recommended size 40x40px.
      * Falls back to a default user icon if not provided.
      */
-    userAvatarSrcUrl?: string;
+    userAvatar?: string;
     /**
      * Controls whether links in chat messages open in new browser tabs.
      * Enable this to help users maintain their chat context when following links.
@@ -518,27 +506,27 @@ export declare interface InkeepAIChatSettings extends ToolConfig {
      */
     shouldOpenLinksInNewTab?: boolean;
     /**
-     * Custom heading text for the quick questions section.
+     * Custom heading text for the example questions section.
      * Use this to better describe your suggested queries.
      * @example "Common Questions" or "Try asking about..."
      */
-    quickQuestionsLabel?: string;
+    exampleQuestionsLabel?: string;
     /**
      * A list of pre-written questions users can click to quickly start a conversation.
-     * These should reflect common use cases and help users understand the bot's capabilities.
+     * These should reflect common use cases and help users understand the AI assistant's capabilities.
      * @example ["How do I reset my password?", "What are the API rate limits?"]
      */
-    quickQuestions?: string[];
+    exampleQuestions?: string[];
     /**
-     * Whether to visually emphasize the first quick question.
+     * Whether to visually emphasize the first example question.
      * Use this to draw attention to the most important or common query.
      */
-    shouldHighlightFirstQuickQuestion?: boolean;
+    isFirstExampleQuestionHighlighted?: boolean;
     /**
      * Enables the ability to share chat conversations via URL.
      * Useful for allowing users to share helpful conversations with teammates.
      */
-    isChatSharingEnabled?: boolean;
+    isShareButtonVisible?: boolean;
     /**
      * The base URL path used when generating shareable chat links.
      * Should match your application's routing structure.
@@ -549,7 +537,7 @@ export declare interface InkeepAIChatSettings extends ToolConfig {
      * Controls the visibility of the copy chat button.
      * Allows users to copy the entire chat transcript to their clipboard.
      */
-    shouldShowCopyChatButton?: boolean;
+    isCopyChatButtonVisible?: boolean;
     /**
      * Unique identifier for loading a specific chat session.
      * Use this to restore a previous conversation state.
@@ -580,7 +568,7 @@ export declare interface InkeepAIChatSettings extends ToolConfig {
      * Array of actions available in the "Get Help" menu.
      * Use this to provide alternative support options like contact forms or documentation links.
      */
-    getHelpCallToActions?: GetHelpCallToAction[];
+    getHelpOptions?: GetHelpOption[];
     /**
      * System-level instructions that guide the AI's behavior and responses.
      * Use these to define the assistant's personality, knowledge boundaries, and response style.
@@ -595,12 +583,11 @@ export declare interface InkeepAIChatSettings extends ToolConfig {
      * Collection of interactive workflows that can be triggered during chat.
      * These can guide users through complex processes or data collection.
      */
-    workflows?: Workflow[];
     /**
      * Custom labels for the chat interface's action buttons.
      * Use this for internationalization or to better match your application's terminology.
      */
-    actionButtonLabels?: AIChatActionButtonLabels;
+    toolbarButtonLabels?: AIChatToolbarButtonLabels;
     /**
      * Specifies which AI model to use for generating responses.
      * Different models may have different capabilities or specializations.
@@ -654,33 +641,31 @@ export declare interface InkeepBaseSettings {
      */
     userAuthToken?: string;
     /**
-     * Callback function to handle analytics events from the widget.
-     * Receives InkeepCallbackEvent objects containing event details.
+     * Handler for analytics events from the widget.
      * @param event The analytics event object
      */
-    logEventCallback?: (event: InkeepCallbackEvent) => void;
+    onEvent?: (event: InkeepCallbackEvent) => void;
     /**
-     * Configuration for analytics behavior and tracking.
-     * Controls what events are tracked and how they are processed.
+     * Privacy and cookie preferences configuration.
      */
-    analytics?: Analytics;
+    privacyPreferences?: PrivacyPreferences;
     /**
      * Custom base URL for analytics API endpoints.
      * Useful when routing analytics requests through a proxy.
      * Should include protocol (e.g., 'https://analytics.your-proxy.com')
      */
-    analyticsBaseUrl?: string;
+    analyticsApiBaseUrl?: string;
     /**
      * Custom base URL for search and chat API endpoints.
      * Useful when routing API requests through a proxy.
      * Should include protocol (e.g., 'https://api.your-proxy.com')
      */
-    baseUrl?: string;
+    aiApiBaseUrl?: string;
     /**
      * Whether to bypass the captcha challenge. Only enable this flag if using a server side API type api key, otherwise the api requests will fail without the challenge solution.
      * @default false
      */
-    bypassChallenge?: boolean;
+    shouldBypassCaptcha?: boolean;
     /**
      * Function to transform source data before display.
      * Allows customizing how source information is presented in the widget.
@@ -691,9 +676,9 @@ export declare interface InkeepBaseSettings {
     /**
      * Environment setting for the widget.
      * Affects API endpoints and debug behaviors.
-     * @default 'PRODUCTION'
+     * @default 'production'
      */
-    env?: 'DEVELOPMENT' | 'PRODUCTION';
+    env?: 'development' | 'production';
     /**
      * Reference to the shadow DOM host element if using custom Shadow DOM.
      * Required when embedding the widget within a Shadow DOM.
@@ -720,7 +705,7 @@ export declare interface InkeepBaseSettings {
      * Useful for tracking or maintaining context in navigation.
      * Object mapping parameter names to values.
      */
-    appendQueryParamsToUrls?: UrlQueryParam;
+    urlQueryParamsToAppend?: UrlQueryParam;
 }
 
 export declare type InkeepCallbackEvent = InkeepEventWithCommon & {
@@ -733,10 +718,7 @@ export declare interface InkeepConfig {
      * @default 'ikp'
      */
     prefix?: string;
-    /**
-     * The type widget.
-     */
-    interactionType: any;
+    /* Excluded from this release type: componentType */
     /**
      * Configuration for the chat.
      */
@@ -767,13 +749,13 @@ export declare type InkeepEventWithCommon = ExtendPropertiesWithCommon<InkeepEve
 
 export declare interface InkeepModalSettings {
     /**
-     * Whether the modal is open.
+     * Controls whether the modal is open.
      */
-    open?: boolean;
+    isOpen?: boolean;
     /**
-     * Callback fired when the modal open state changes.
+     * Handler called when the modal opens or closes.
      */
-    onOpenChange?: (open: boolean) => void;
+    onOpenChange?: (isOpen: boolean) => void;
     /**
      * The shortcut key.
      *
@@ -807,18 +789,18 @@ export declare interface InkeepSearchSettings {
      * The maximum number of hits to return.
      * @default 40
      */
-    maximumHitsLimit?: number;
+    maxResults?: number;
     /**
      * The time in milliseconds to wait triggering the search.
      * @default 0
      */
-    debounceTime?: number;
+    debounceTimeMs?: number;
     /**
      * Ref to the AIChat component's callable functions
      */
     searchFunctionsRef?: React.Ref<SearchFunctions>;
     /**
-     * Whether to open links in new tab.
+     * Controls whether links should open in a new tab.
      * @default false
      */
     shouldOpenLinksInNewTab?: boolean;
@@ -830,17 +812,17 @@ export declare interface InkeepSearchSettings {
      * Behavior:
      * - Omit 'All' from tabs array to hide the All tab
      * - Empty tabs array will show all results without tab UI
-     * - Tabs only appear when they have results, unless alwaysVisible is set
+     * - Tabs only appear when they have results, unless isAlwaysVisible is set
      *
      * @example
      * ```ts
      * // Basic tabs
      * tabs: ['Publications', 'GitHub']
      *
-     * // With alwaysVisible option
+     * // With isAlwaysVisible option
      * tabs: [
      *   'Publications',
-     *   ['GitHub', { alwaysVisible: true }] // Shows even with no results
+     *   ['GitHub', { isAlwaysVisible: true }] // Shows even with no results
      * ]
      * ```
      */
@@ -898,8 +880,8 @@ export declare interface IntelligentFormConfig {
     successView: IntelligentFormSuccessView;
     /** Callback function called when form is submitted */
     onSubmit: SubmitCallback;
-    /** Optional name of the bot shown in the form */
-    botName?: string;
+    /** Optional name of the assistant shown in the form */
+    aiAssistantName?: string;
 }
 
 export declare interface IntelligentFormContextSuggestionsEvent {
@@ -914,9 +896,9 @@ export declare type IntelligentFormEvent = IntelligentFormSubmittedEvent | Intel
 
 export declare type IntelligentFormField = Exclude<FormField, IncludeChatSessionField> & {
     /**
-     * Controls AI field generation behavior
+     * Controls whether to prefill the field with the AI's response
      */
-    aiGenerated?: boolean;
+    shouldPrefillWithAI?: boolean;
 };
 
 export declare interface IntelligentFormPrimarySubmittedEvent {
@@ -962,7 +944,7 @@ export declare interface IntelligentFormSuccessView {
 }
 
 export declare interface InvokeCallbackAction {
-    type: 'INVOKE_CALLBACK';
+    type: 'invoke_callback';
     callback: (args: InvokeCallbackArgs) => void;
     shouldCloseModal?: boolean;
 }
@@ -1025,15 +1007,33 @@ export declare type OnToggleView = (opts: {
 }) => void;
 
 export declare interface OpenFormAction {
-    type: 'OPEN_FORM';
+    type: 'open_form';
     formConfig: FormConfig;
 }
 
 export declare interface OpenUrlAction {
-    type: 'OPEN_LINK';
+    type: 'open_link';
     url: string;
 }
 
+export declare interface PrivacyPreferences {
+    /**
+     * Whether to opt out of analytical cookies.
+     * @default false
+     */
+    optOutAnalyticalCookies?: boolean;
+    /**
+     * Whether to opt out of all analytics.
+     * @default false
+     */
+    optOutAllAnalytics?: boolean;
+    /**
+     * Whether to opt out of functional cookies.
+     * @default false
+     */
+    optOutFunctionalCookies?: boolean;
+}
+
 declare type RecordTypes = 'DocumentationRecord' | 'GitHubIssueRecord' | 'StackOverflowRecord' | 'DiscordRecord' | 'SlackEntry' | 'DiscourseRecord';
 
 export declare type RenderFn = ({ children, ssr, root, }: {
@@ -1125,12 +1125,12 @@ export declare interface SearchRootRecord {
 export declare interface SearchTab {
     [0]: string;
     [1]: {
-        alwaysVisible?: boolean;
+        isAlwaysVisible?: boolean;
     };
 }
 
 declare interface SelectField extends BaseFormField {
-    inputType: 'SELECT';
+    inputType: 'select';
     items: SelectItem[];
     defaultValue?: string;
     placeholder?: string;
@@ -1262,9 +1262,12 @@ export declare interface SyncColorMode {
      *
      * // Watch a specific container element
      * target: document.querySelector('#app')
+     *
+     * // Watch a specific element by ID
+     * target: '#app'
      * ```
      */
-    target: HTMLElement;
+    target: HTMLElement | string;
     /**
      * The specific attributes to monitor for color mode changes.
      * The observer will only trigger when these attributes change on the target element.
@@ -1308,7 +1311,7 @@ export declare interface SyncColorMode {
      * isDarkMode: (attributes) => attributes['color-scheme'] === 'dark'
      * ```
      */
-    isDarkMode: (attributes: Record<string, string | null>) => boolean;
+    isDarkMode?: (attributes: Record<string, string | null>) => boolean;
     /**
      * Optional callback function that is invoked whenever the color mode changes.
      *
@@ -1337,7 +1340,7 @@ export declare interface SystemMessage extends MessageBase {
 }
 
 declare interface TextField extends BaseFormField {
-    inputType: 'EMAIL' | 'TEXT' | 'TEXTAREA';
+    inputType: 'email' | 'text' | 'textarea';
     defaultValue?: string;
     placeholder?: string;
 }
@@ -1698,7 +1701,7 @@ export declare interface WorkflowModalSingleInput extends WorkflowBaseInputTypes
 }
 
 export declare interface WorkflowTextContentType extends WorkflowBaseContentType {
-    type: 'TEXT';
+    type: 'text';
 }
 
 export { }

package/package.json

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