@deepdesk/deepdesk-sdk 17.0.0-rc.8 → 17.0.0

package/dist/index.d.mts

@@ -107,6 +107,7 @@ declare const styles$o: {
   readonly "dropdownItemButton": string;
   readonly "dropdownList": string;
   readonly "fadein": string;
+  readonly "icon": string;
   readonly "isClickable": string;
   readonly "isSelected": string;
   readonly "label": string;
@@ -492,7 +493,6 @@ declare namespace Server {
         visitor_name: string | null;
         chat_start_time: string | null;
         external_id: string;
-        messages: ConversationMessage[];
         metadata: Metadata;
     };
     /**
@@ -593,64 +593,10 @@ declare namespace Server {
             suggestion: string;
         }[];
     };
-    enum EventType {
-        SEND_MESSAGE = "Send Message",
-        HANDLING_TIME = "Handling Time",
-        ADD_TO_PERSONAL_COLLECTION = "Add to personal collection",
-        DELETE_FROM_PERSONAL_COLLECTION = "Delete from personal collection"
-    }
-    type UsedSuggestion = {
-        ab_test_name?: string | null;
-        ab_variant?: string | null;
-        input_type: string;
-        source?: string;
-        source_text?: string;
-        text: string;
-        training_jobs?: string[];
-    };
-    /**
-     * Abstract API object for event data
-     * @deprecated in favor of EventDataV2
-     * @see EventV2Data
-     */
-    type EventData = {
-        conversation_id: string;
-        client_version: string;
-        source: 'agent' | 'visitor';
-        pastes: string[];
-        cuts: string[];
-        deletions: string[];
-        len_text_typed: number;
-        len_text_total: number;
-        len_text_assisted: number;
-        len_text_pasted: number;
-        len_text_cut: number;
-        len_text_deleted: number;
-        time_total_seconds: number;
-        chars_per_second: number;
-        text: string;
-        num_pastes: number;
-        text_suggestions_v2: UsedSuggestion[];
-        url_suggestions_v2: UsedSuggestion[];
-        url_link_suggestions_v2: UsedSuggestion[];
-        suggestions_counters: {
-            source: Sources;
-            count_offered: number;
-        }[];
-        time_start: string;
-        time_stop: string;
-        agent_id?: string;
-        agent_name?: string;
-        agent_email?: string;
-        platform: string;
-        backend_version: string;
-        engine_version: string;
-        gpt_version: string;
-    };
     /**
      * Backend API object for event data v2
      */
-    type EventV2Data = {
+    type EventData = {
         name: string;
         platform?: string;
         conversation_id?: string;
@@ -701,15 +647,28 @@ declare namespace Server {
     /**
      * Handling time event data
      */
-    type HandlingTimeEventData = Pick<EventData, 'conversation_id' | 'client_version' | 'time_start' | 'time_stop'> & Partial<Pick<EventData, 'agent_id' | 'agent_name' | 'agent_email'>>;
+    type HandlingTimeEventData = {
+        client_version: string;
+        time_start: string;
+        time_stop: string;
+    };
     /**
      * Send message event data
      */
-    type SendMessageEventData = Pick<EventData, 'client_version' | 'conversation_id' | 'source' | 'pastes' | 'cuts' | 'deletions' | 'len_text_typed' | 'len_text_total' | 'len_text_assisted' | 'len_text_pasted' | 'len_text_cut' | 'len_text_deleted' | 'time_total_seconds' | 'chars_per_second' | 'num_pastes' | 'text' | 'text_suggestions_v2' | 'suggestions_counters'> & Partial<Pick<EventData, 'agent_id' | 'agent_name' | 'agent_email'>>;
-    /**
-     * PersonalCollection event data
-     */
-    type PersonalCollectionEventData = Pick<EventData, 'text' | 'platform'>;
+    type SendMessageEventData = {
+        client_version: string;
+        source: string;
+        len_text_total: number;
+        pastes: string[];
+        num_pastes: number;
+        suggestions: Array<{
+            input_type: string;
+            source?: Sources;
+            source_text?: string;
+            text: string;
+            training_jobs?: Array<string>;
+        }>;
+    };
     /**
      * Search results data
      */
@@ -772,27 +731,17 @@ declare namespace Server {
         sticky_messages: boolean;
         recommend_text_suggestions: boolean;
         assisted_intake: boolean;
-        autocomplete_with_text_suggestions: boolean;
         entities_command: boolean;
-        summarizer: boolean;
-        summarizer_prompt_instruction: string;
-        summarizer_model: string;
-        /**
-         * Old rule group
-         * @deprecated in favor of `summarizer_assistant_new`
-         */
-        summarizer_assistant?: string;
-        summarizer_assistant_new?: string;
-        conversation_accepted_assistant?: string;
-        conversation_new_message_assistant?: string;
-        conversation_ended_assistant?: string;
+        summarizer_assistant_new: string | null;
+        conversation_accepted_assistant: string | null;
+        conversation_new_message_assistant: string | null;
+        conversation_ended_assistant: string | null;
         /**
          * @deprecated in favor of `knowledge_assistant_new`
          */
-        knowledge_assistant: string;
-        knowledge_assistant_new: string;
+        knowledge_assistant: string | null;
+        knowledge_assistant_new: string | null;
         on_demand_assistants: Array<OnDemandAssistant>;
-        authorized_groups: number[];
         active_config: {
             default_locale: string;
         };
@@ -805,6 +754,7 @@ declare namespace Server {
                     amount: number;
                     lines: 'multiple' | 'single';
                     schema?: CustomDataSchema;
+                    property?: string;
                 }>;
             };
             search: {
@@ -871,10 +821,8 @@ declare namespace Server {
 type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'metadata'>> & {
     metadata: Server.Metadata | null;
 };
-type Conversation = CamelCaseKeys<Omit<Server.Conversation, 'metadata' | 'messages'>> & {
+type Conversation = CamelCaseKeys<Omit<Server.Conversation, 'metadata'>> & {
     metadata: Server.Metadata;
-} & {
-    messages: ConversationMessage[];
 };
 /**
  * Create Conversation Options
@@ -910,15 +858,15 @@ type CreateConversationOptions = {
  */
 type SendMessageEventData = CamelCaseKeys<Server.SendMessageEventData>;
 /**
- * Event v2 payload
+ * Event payload
  */
-type EventV2<T = unknown> = CamelCaseKeys<Omit<Server.EventV2Data, 'name' | 'backend_version' | 'engine_version' | 'gpt_version' | 'data'>> & {
+type Event$1<T = unknown> = CamelCaseKeys<Omit<Server.EventData, 'name' | 'backend_version' | 'engine_version' | 'gpt_version' | 'data'>> & {
     data: T;
 };
 /**
  * Handling time event data
  */
-type HandlingTimeEventData = CamelCaseKeys<Pick<Server.HandlingTimeEventData, 'conversation_id' | 'client_version' | 'time_start' | 'time_stop'>>;
+type HandlingTimeEventData = CamelCaseKeys<Server.HandlingTimeEventData>;
 /**
  * Rule event meta data
  */
@@ -928,67 +876,61 @@ type RuleEventMeta = {
     group: string;
 };
 /**
- * Map the send event name to the data value in the payload. (V1)
- * @deprecated
- */
-type SendEventV1ArgumentMap = {
-    'Send Message': SendMessageEventData;
-    'Handling Time': HandlingTimeEventData;
-};
-/**
- * Map the send event name to the data value in the payload. (V2)
+ * Map the send event name to the data value in the payload
  */
-type SendEventV2ArgumentMap = {
-    'Add to personal collection': EventV2<{
+type SendEventArgumentMap = {
+    'Send Message': Event$1<SendMessageEventData>;
+    'Handling Time': Event$1<HandlingTimeEventData>;
+    'Add to personal collection': Event$1<{
         text: string;
     }>;
-    'Delete from personal collection': EventV2<{
+    'Delete from personal collection': Event$1<{
         text: string;
     }>;
-    'entities found': EventV2<{
+    'entities found': Event$1<{
         entities: Entity[];
     }>;
-    'conversation summarized': EventV2<{
+    'conversation summarized': Event$1<{
         summary: string;
         assistant?: string;
     }>;
-    'style suggested': EventV2<{
+    'style suggested': Event$1<{
         keywordMatches: {
             keyword: string;
             suggestion: string;
         }[];
     }>;
-    'Image attached': EventV2<{
+    'Image attached': Event$1<{
         path: string;
         title: string;
     }>;
-    'Assistant response displayed': EventV2<RuleEventMeta & {
+    'Assistant response displayed': Event$1<RuleEventMeta & {
         cueText: string;
     }>;
-    'Assistant response closed': EventV2<RuleEventMeta & {
+    'Assistant response closed': Event$1<RuleEventMeta & {
         cueText: string;
     }>;
-    'Assistant response feedback': EventV2<RuleEventMeta & {
+    'Assistant response feedback': Event$1<RuleEventMeta & {
         rating: 'up' | 'down';
         cueText: string;
     }>;
-    'Assistant response used': EventV2<RuleEventMeta & {
+    'Assistant response used': Event$1<RuleEventMeta & {
         usedText: string;
     }>;
-    'Assistant response copied': EventV2<RuleEventMeta & {
+    'Assistant response copied': Event$1<RuleEventMeta & {
         copiedText: string;
     }>;
-    'Assistant call to action': EventV2<RuleEventMeta & {
+    'Assistant call to action': Event$1<RuleEventMeta & {
         eventName: string;
         value: string;
     }>;
-    'knowledge assist feedback': EventV2<{
+    'knowledge assist feedback': Event$1<{
         question: string;
         isFollowUpQuestion: boolean;
         isAgent: boolean;
         answer: Server.KnowledgeResponse['answer'];
     }>;
-    'knowledge assist question answered': EventV2<{
+    'knowledge assist question answered': Event$1<{
         question: string;
         answer: string;
         sources: {
@@ -998,32 +940,32 @@ type SendEventV2ArgumentMap = {
         isFollowUpQuestion: boolean;
         isAutoInitiated: boolean;
     }>;
-    'knowledge assist source viewed': EventV2<{
+    'knowledge assist source viewed': Event$1<{
         question: string;
         sourceViewed: string;
     }>;
-    'knowledge assist reset': EventV2<{
+    'knowledge assist reset': Event$1<{
         threadId?: number;
     }>;
-    'summary feedback': EventV2<{
+    'summary feedback': Event$1<{
         summary: string;
         rating: 'up' | 'down';
     }>;
-    'summary copied to clipboard': EventV2<{
+    'summary copied to clipboard': Event$1<{
         originalText: string;
         finalText: string;
         assistant: string;
     }>;
-    'open search': EventV2<{
+    'open search': Event$1<{
         via: 'ctrl+k' | 'autocomplete-overlay' | 'widget-shortcut';
     }>;
-    'open knowledge assistant': EventV2<{
+    'open knowledge assistant': Event$1<{
         via: 'ctrl+k' | 'widget-shortcut' | 'search-command';
     }>;
-    'open my deepdesk': EventV2<{
+    'open my deepdesk': Event$1<{
         via: 'widget-shortcut';
     }>;
-    'trigger on demand assistant': EventV2<{
+    'trigger on demand assistant': Event$1<{
         assistantCode: string;
     }>;
 };
@@ -1080,30 +1022,15 @@ declare class DeepdeskAPI {
     /**
      * Update converstation meta data
      */
-    updateConversation(conversationId: string, data: Partial<Omit<Conversation, 'messages'>>): Promise<Conversation>;
+    updateConversation(conversationId: string, data: Partial<Conversation>): Promise<Conversation>;
     /**
      * Post converstation messages
      */
-    postMessages(conversationId: string, messages: CamelCaseKeys<Server.ConversationMessage>[]): Promise<({
-        text: string;
-        source: "agent" | "visitor" | "bot" | "system";
-        time: string;
-        externalId: string;
-        authorId: string;
-        authorName?: string | undefined;
-        authorEmail?: string | undefined;
-    } & {
-        metadata: Server.Metadata | null;
-    })[]>;
-    /**
-     * Send event with meta data for analytics
-     */
-    sendEvent<T extends keyof SendEventV2ArgumentMap>(event: T, payload: SendEventV2ArgumentMap[T]): Promise<void>;
+    postMessages(conversationId: string, messages: CamelCaseKeys<Server.ConversationMessage>[]): Promise<void>;
     /**
      * Send event with meta data for analytics
-     * @deprecated
      */
-    sendEventV1<T extends keyof SendEventV1ArgumentMap>(event: T, payload: SendEventV1ArgumentMap[T]): Promise<void>;
+    sendEvent<T extends keyof SendEventArgumentMap>(event: T, payload: SendEventArgumentMap[T]): Promise<void>;
     getEntities(messages: Array<{
         text: string;
     }>): Promise<Entity[]>;
@@ -1384,7 +1311,7 @@ type AssistantInteraction = {
 type State$2 = {
     cues: Cue[];
     threads: Record<number, AssistantInteraction[]>;
-    fetchState: FetchState;
+    pending: string[];
 };
 type Transcript = Array<{
     source: string;
@@ -2072,6 +1999,7 @@ interface WidgetOptions {
 interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
     customStyles?: WidgetCustomStyles;
     isLegacyKnowledgeAssist?: boolean;
+    title?: string;
 }
 declare class DeepdeskSDK {
     static version: string;
@@ -2088,6 +2016,7 @@ declare class DeepdeskSDK {
     private widgetElement;
     private widgetRoot;
     private dynamicThunkObject;
+    private queues;
     isMounted: boolean;
     instanceId: number;
     private shouldRender;
@@ -2221,7 +2150,7 @@ declare class DeepdeskSDK {
      * Method to call when the conversation is updated, either by an incoming message
      * from the visitor, or a message sent by the agent.
      */
-    postMessages(messages: ConversationMessage[]): Promise<any>;
+    postMessages(messages: ConversationMessage[]): Promise<void>;
     /**
      * Update converstation meta data
      */