@inkeep/cxkit-types 0.5.33 → 0.5.35

package/dist/index.d.ts

@@ -690,6 +690,47 @@ export declare type InkeepCallbackEvent = InkeepEventWithCommon & {
     userProperties: UserProperties;
 };
 
+export declare type InkeepComponentInitializer = {
+    (props: InkeepComponentProps): InkeepComponentInstance;
+    (targetSelector: string, props: InkeepComponentProps): InkeepComponentInstance;
+};
+
+/**
+ * Represents an instance of any Inkeep component that is returned after initialization.
+ * These instances have methods that can be used to update the component's state.
+ */
+export declare interface InkeepComponentInstance {
+    /**
+     * Updates the component with new props
+     * @param newProps The new props to apply to the component
+     */
+    update: <T extends object>(newProps: T) => void;
+    /**
+     * Unmounts the component from the DOM but preserves its state
+     */
+    unmount: () => void;
+    /**
+     * Remounts a previously unmounted component
+     */
+    remount: () => void;
+    /**
+     * Access to chat-specific functionality (only available for components with chat capabilities)
+     */
+    chat?: {
+        [key: string]: (...args: any[]) => any;
+    };
+    /**
+     * Access to search-specific functionality (only available for components with search capabilities)
+     */
+    search?: {
+        [key: string]: (...args: any[]) => any;
+    };
+}
+
+export declare type InkeepComponentProps = InkeepSettings & {
+    [key: string]: any;
+};
+
 export declare interface InkeepConfig {
     /**
      * The prefix to use for the widget.
@@ -725,6 +766,14 @@ export declare type InkeepEvent = SearchEvent | ChatEvent | IntelligentFormEvent
 
 export declare type InkeepEventWithCommon = ExtendPropertiesWithCommon<InkeepEvent>;
 
+export declare type InkeepJS = Partial<Record<InkeepJSComponent, InkeepComponentInitializer>>;
+
+/**
+ * Represents the available Inkeep component types that can be rendered
+ * via the global Inkeep object.
+ */
+export declare type InkeepJSComponent = 'EmbeddedChat' | 'EmbeddedSearch' | 'EmbeddedSearchAndChat' | 'ModalChat' | 'ModalSearch' | 'ModalSearchAndChat' | 'IntelligentForm' | 'ChatButton' | 'SearchBar';
+
 export declare interface InkeepModalSettings {
     /**
      * Controls whether the modal is open.
@@ -824,6 +873,13 @@ export declare interface InkeepSearchSettings {
     filters?: SearchAndChatFilters;
 }
 
+declare interface InkeepSettings {
+    baseSettings?: InkeepBaseSettings;
+    aiChatSettings?: InkeepAIChatSettings;
+    searchSettings?: InkeepSearchSettings;
+    modalSettings?: InkeepModalSettings;
+}
+
 export declare type InputMaybe<T> = T | null;
 
 export declare interface IntelligentFormAIResponseProvidedEvent {

package/package.json

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