@inkeep/cxkit-types 0.0.0-dev-20250228015002 → 0.0.0-dev-20250228055234

package/dist/index.d.ts

@@ -34,6 +34,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 +82,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.
@@ -217,10 +247,6 @@ declare interface CheckboxField extends BaseFormField {
     defaultValue?: boolean;
 }
 
-export declare interface Client {
-    currentUrl: string;
-}
-
 export declare type CloseFormAction = 'return_to_chat' | 'close_modal';
 
 export declare interface CodeBlockCopiedEvent {
@@ -401,24 +427,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']>;
@@ -848,40 +856,12 @@ export declare interface IntelligentFormAIErrorEvent {
     };
 }
 
-export declare interface IntelligentFormConfig {
-    /**
-     * Primary form section that is always shown
-     */
-    primary: {
-        /** Array of form fields to display */
-        fields: IntelligentFormField[];
-        /** Optional description text shown above the fields */
-        description?: string;
-    };
-    /**
-     * Secondary form section that can be conditionally shown
-     */
-    secondary: {
-        /** Array of form fields to display */
-        fields: IntelligentFormField[];
-        /**
-         * Optional description text shown above the fields.
-         * Can be either a simple string or an object with different messages
-         * based on AI confidence level
-         */
-        description?: string | {
-            /** Default message shown when AI confidence is low/medium */
-            default: string;
-            /** Message shown when AI has high confidence */
-            confident: string;
-        };
-    };
-    /** Configuration for the success view shown after form submission */
-    successView: IntelligentFormSuccessView;
+export declare interface IntelligentFormButtons {
     /** Callback function called when form is submitted */
-    onSubmit: SubmitCallback;
-    /** Optional name of the assistant shown in the form */
-    aiAssistantName?: string;
+    submit: {
+        label?: string;
+        onSubmit: SubmitCallback;
+    };
 }
 
 export declare interface IntelligentFormContextSuggestionsEvent {
@@ -921,6 +901,42 @@ export declare interface IntelligentFormQAResponseEvent {
     };
 }
 
+export declare interface IntelligentFormSettings {
+    /**
+     * Primary form section that is always shown
+     */
+    primary: {
+        /** Array of form fields to display */
+        fields: IntelligentFormField[];
+        /** Optional description text shown above the fields */
+        description?: string;
+    };
+    /**
+     * Secondary form section that can be conditionally shown
+     */
+    secondary: {
+        /** Array of form fields to display */
+        fields: IntelligentFormField[];
+        /**
+         * Optional description text shown above the fields.
+         * Can be either a simple string or an object with different messages
+         * based on AI confidence level
+         */
+        description?: string | {
+            /** Default message shown when AI confidence is low/medium */
+            default: string;
+            /** Message shown when AI has high confidence */
+            confident: string;
+        };
+    };
+    /** Configuration for the success view shown after form submission */
+    successView: IntelligentFormSuccessView;
+    /** Configuration for the buttons shown in the form */
+    buttons: IntelligentFormButtons;
+    /** Optional name of the assistant shown in the form */
+    aiAssistantName?: string;
+}
+
 export declare interface IntelligentFormSubmissionErrorEvent {
     eventName: 'intelligent_form_submission_error';
     properties: {
@@ -1008,7 +1024,7 @@ export declare type OnToggleView = (opts: {
 
 export declare interface OpenFormAction {
     type: 'open_form';
-    formConfig: FormConfig;
+    formSettings: AIChatFormSettings;
 }
 
 export declare interface OpenUrlAction {
@@ -1233,19 +1249,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 {

package/package.json

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