@deepdesk/deepdesk-sdk 11.1.1-beta.2 → 11.1.1-beta.4

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import React, { FC, HTMLAttributes, ForwardRefExoticComponent, RefAttributes, ReactNode, SyntheticEvent } from 'react';
+import React, { FC, HTMLAttributes, ForwardRefExoticComponent, RefAttributes, ButtonHTMLAttributes, ReactNode, SyntheticEvent } from 'react';
 import * as redux from 'redux';
 import * as _reduxjs_toolkit_dist_configureStore from '@reduxjs/toolkit/dist/configureStore';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
@@ -103,14 +103,15 @@ declare const styles$g: {
   readonly "actionButtonIsDisabled": string;
   readonly "labels": string;
   readonly "label": string;
-  readonly "closeIcon": string;
+  readonly "iconButtons": string;
+  readonly "iconButton": string;
 };
 
 interface ActionsProps extends HTMLAttributes<HTMLElement> {
     fixed?: boolean;
 }
-interface CloseIconProps extends React.HTMLProps<HTMLDivElement> {
-    className?: string;
+interface IconButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
+    icon?: ReactNode;
 }
 interface ActionButtonProps extends HTMLAttributes<HTMLElement> {
     primary?: boolean;
@@ -135,7 +136,7 @@ interface SuggestionComposition {
     DropdownButton: FC<ActionButtonProps>;
     DropdownItem: FC<DropdownItemProps>;
     Labels: FC<LabelProps>;
-    CloseIcon: FC<CloseIconProps>;
+    IconButton: FC<IconButtonProps>;
 }
 type SuggestionStyles = typeof styles$g;
 declare const Suggestion: ForwardRefExoticComponent<Props$2 & RefAttributes<any>> & SuggestionComposition;
@@ -947,6 +948,7 @@ declare namespace Server {
      */
     type EventV2Data = {
         name: string;
+        platform?: string;
         conversation_id?: string;
         agent_id?: string;
         agent_name?: string;
@@ -969,9 +971,9 @@ declare namespace Server {
         profile_code: string;
     }
     interface Cue {
-        id: string;
         text: string;
         title: string;
+        rule: Rule;
     }
     /**
      * Handling time event data
@@ -1136,7 +1138,9 @@ type SendMessageEventData$1 = CamelCaseKeys<Server.SendMessageEventData>;
 /**
  * Event v2 payload
  */
-type EventV2Payload = CamelCaseKeys<Omit<Server.EventV2Data, 'name' | 'backend_version' | 'engine_version' | 'gpt_version'>>;
+type EventV2<T = unknown> = CamelCaseKeys<Omit<Server.EventV2Data, 'name' | 'backend_version' | 'engine_version' | 'gpt_version' | 'data'>> & {
+    data: T;
+};
 /**
  * Handling time event data
  */
@@ -1146,24 +1150,60 @@ type HandlingTimeEventData = CamelCaseKeys<Pick<Server.HandlingTimeEventData, 'c
  */
 type AutoflowEventData = CamelCaseKeys<Server.AutoflowEventData>;
 /**
- * Personal collection event data
+ * Rule event meta data
  */
-type PersonalCollectionEventData = CamelCaseKeys<Server.PersonalCollectionEventData>;
+type RuleEventMeta = {
+    name: string;
+    description: string;
+    group: string;
+};
 /**
- * Send event arguments helper
+ * Map the send event name to the data value in the payload. (V1)
+ * @deprecated
  */
-type SendEventArgumentMap = {
+type SendEventV1ArgumentMap = {
     'Send Message': SendMessageEventData$1;
     'Handling Time': HandlingTimeEventData;
     'Start Autoflow': AutoflowEventData;
     'Abort Autoflow': AutoflowEventData;
-    'Add to personal collection': PersonalCollectionEventData;
-    'Delete from personal collection': PersonalCollectionEventData;
-    'entities found': EventV2Payload;
-    'conversation summarized': EventV2Payload;
-    'style suggested': EventV2Payload;
-    'suggestion edited': EventV2Payload;
-    'Image attached': EventV2Payload;
+};
+/**
+ * Map the send event name to the data value in the payload. (V2)
+ */
+type SendEventV2ArgumentMap = {
+    'Add to personal collection': EventV2<{
+        text: string;
+    }>;
+    'Delete from personal collection': EventV2<{
+        text: string;
+    }>;
+    'entities found': EventV2<{
+        entities: Entity[];
+    }>;
+    'conversation summarized': EventV2<{
+        summary: string;
+    }>;
+    'style suggested': EventV2<{
+        keywordMatches: {
+            keyword: string;
+            suggestion: string;
+        }[];
+    }>;
+    'Image attached': EventV2<{
+        path: string;
+        title: string;
+    }>;
+    'Assistant response displayed': EventV2<RuleEventMeta>;
+    'Assistant response closed': EventV2<RuleEventMeta>;
+    'Assistant response feedback': EventV2<RuleEventMeta & {
+        thumb: 'up' | 'down';
+    }>;
+    'Assistant response used': EventV2<RuleEventMeta & {
+        usedText: string;
+    }>;
+    'Assistant response copied': EventV2<RuleEventMeta & {
+        copiedText: string;
+    }>;
 };
 /**
  * Request retry options
@@ -1228,12 +1268,12 @@ declare class DeepdeskAPI {
     /**
      * Send event with meta data for analytics
      */
-    sendEvent<T extends keyof SendEventArgumentMap>(event: T, payload: SendEventArgumentMap[T]): Promise<void>;
+    sendEvent<T extends keyof SendEventV2ArgumentMap>(event: T, payload: SendEventV2ArgumentMap[T]): Promise<void>;
     /**
      * Send event with meta data for analytics
      * @deprecated
      */
-    sendEventV1<T extends keyof SendEventArgumentMap>(event: T, payload: SendEventArgumentMap[T]): Promise<void>;
+    sendEventV1<T extends keyof SendEventV1ArgumentMap>(event: T, payload: SendEventV1ArgumentMap[T]): Promise<void>;
     getEntities(messages: Array<{
         text: string;
     }>): Promise<Entity[]>;
@@ -1505,9 +1545,7 @@ interface State$2 {
     isInitialRequest: null | boolean;
 }
 
-type Cue = CamelCaseKeys<Server.Cue> & {
-    timestamp?: number;
-};
+type Cue = CamelCaseKeys<Server.Cue>;
 type State$1 = {
     cues: Cue[];
     fetchState: FetchState;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import React, { FC, HTMLAttributes, ForwardRefExoticComponent, RefAttributes, ReactNode, SyntheticEvent } from 'react';
+import React, { FC, HTMLAttributes, ForwardRefExoticComponent, RefAttributes, ButtonHTMLAttributes, ReactNode, SyntheticEvent } from 'react';
 import * as redux from 'redux';
 import * as _reduxjs_toolkit_dist_configureStore from '@reduxjs/toolkit/dist/configureStore';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
@@ -103,14 +103,15 @@ declare const styles$g: {
   readonly "actionButtonIsDisabled": string;
   readonly "labels": string;
   readonly "label": string;
-  readonly "closeIcon": string;
+  readonly "iconButtons": string;
+  readonly "iconButton": string;
 };
 
 interface ActionsProps extends HTMLAttributes<HTMLElement> {
     fixed?: boolean;
 }
-interface CloseIconProps extends React.HTMLProps<HTMLDivElement> {
-    className?: string;
+interface IconButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
+    icon?: ReactNode;
 }
 interface ActionButtonProps extends HTMLAttributes<HTMLElement> {
     primary?: boolean;
@@ -135,7 +136,7 @@ interface SuggestionComposition {
     DropdownButton: FC<ActionButtonProps>;
     DropdownItem: FC<DropdownItemProps>;
     Labels: FC<LabelProps>;
-    CloseIcon: FC<CloseIconProps>;
+    IconButton: FC<IconButtonProps>;
 }
 type SuggestionStyles = typeof styles$g;
 declare const Suggestion: ForwardRefExoticComponent<Props$2 & RefAttributes<any>> & SuggestionComposition;
@@ -947,6 +948,7 @@ declare namespace Server {
      */
     type EventV2Data = {
         name: string;
+        platform?: string;
         conversation_id?: string;
         agent_id?: string;
         agent_name?: string;
@@ -969,9 +971,9 @@ declare namespace Server {
         profile_code: string;
     }
     interface Cue {
-        id: string;
         text: string;
         title: string;
+        rule: Rule;
     }
     /**
      * Handling time event data
@@ -1136,7 +1138,9 @@ type SendMessageEventData$1 = CamelCaseKeys<Server.SendMessageEventData>;
 /**
  * Event v2 payload
  */
-type EventV2Payload = CamelCaseKeys<Omit<Server.EventV2Data, 'name' | 'backend_version' | 'engine_version' | 'gpt_version'>>;
+type EventV2<T = unknown> = CamelCaseKeys<Omit<Server.EventV2Data, 'name' | 'backend_version' | 'engine_version' | 'gpt_version' | 'data'>> & {
+    data: T;
+};
 /**
  * Handling time event data
  */
@@ -1146,24 +1150,60 @@ type HandlingTimeEventData = CamelCaseKeys<Pick<Server.HandlingTimeEventData, 'c
  */
 type AutoflowEventData = CamelCaseKeys<Server.AutoflowEventData>;
 /**
- * Personal collection event data
+ * Rule event meta data
  */
-type PersonalCollectionEventData = CamelCaseKeys<Server.PersonalCollectionEventData>;
+type RuleEventMeta = {
+    name: string;
+    description: string;
+    group: string;
+};
 /**
- * Send event arguments helper
+ * Map the send event name to the data value in the payload. (V1)
+ * @deprecated
  */
-type SendEventArgumentMap = {
+type SendEventV1ArgumentMap = {
     'Send Message': SendMessageEventData$1;
     'Handling Time': HandlingTimeEventData;
     'Start Autoflow': AutoflowEventData;
     'Abort Autoflow': AutoflowEventData;
-    'Add to personal collection': PersonalCollectionEventData;
-    'Delete from personal collection': PersonalCollectionEventData;
-    'entities found': EventV2Payload;
-    'conversation summarized': EventV2Payload;
-    'style suggested': EventV2Payload;
-    'suggestion edited': EventV2Payload;
-    'Image attached': EventV2Payload;
+};
+/**
+ * Map the send event name to the data value in the payload. (V2)
+ */
+type SendEventV2ArgumentMap = {
+    'Add to personal collection': EventV2<{
+        text: string;
+    }>;
+    'Delete from personal collection': EventV2<{
+        text: string;
+    }>;
+    'entities found': EventV2<{
+        entities: Entity[];
+    }>;
+    'conversation summarized': EventV2<{
+        summary: string;
+    }>;
+    'style suggested': EventV2<{
+        keywordMatches: {
+            keyword: string;
+            suggestion: string;
+        }[];
+    }>;
+    'Image attached': EventV2<{
+        path: string;
+        title: string;
+    }>;
+    'Assistant response displayed': EventV2<RuleEventMeta>;
+    'Assistant response closed': EventV2<RuleEventMeta>;
+    'Assistant response feedback': EventV2<RuleEventMeta & {
+        thumb: 'up' | 'down';
+    }>;
+    'Assistant response used': EventV2<RuleEventMeta & {
+        usedText: string;
+    }>;
+    'Assistant response copied': EventV2<RuleEventMeta & {
+        copiedText: string;
+    }>;
 };
 /**
  * Request retry options
@@ -1228,12 +1268,12 @@ declare class DeepdeskAPI {
     /**
      * Send event with meta data for analytics
      */
-    sendEvent<T extends keyof SendEventArgumentMap>(event: T, payload: SendEventArgumentMap[T]): Promise<void>;
+    sendEvent<T extends keyof SendEventV2ArgumentMap>(event: T, payload: SendEventV2ArgumentMap[T]): Promise<void>;
     /**
      * Send event with meta data for analytics
      * @deprecated
      */
-    sendEventV1<T extends keyof SendEventArgumentMap>(event: T, payload: SendEventArgumentMap[T]): Promise<void>;
+    sendEventV1<T extends keyof SendEventV1ArgumentMap>(event: T, payload: SendEventV1ArgumentMap[T]): Promise<void>;
     getEntities(messages: Array<{
         text: string;
     }>): Promise<Entity[]>;
@@ -1505,9 +1545,7 @@ interface State$2 {
     isInitialRequest: null | boolean;
 }
 
-type Cue = CamelCaseKeys<Server.Cue> & {
-    timestamp?: number;
-};
+type Cue = CamelCaseKeys<Server.Cue>;
 type State$1 = {
     cues: Cue[];
     fetchState: FetchState;