@deepdesk/deepdesk-sdk 10.0.0 → 10.1.0

package/dist/index.d.mts

@@ -283,9 +283,9 @@ interface StoreConfig {
 }
 declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configureStore.ToolkitStore<redux.EmptyObject & {
     activeSuggestion: State$e;
-    answer: State$6;
+    answer: State$c;
     auth: State$d;
-    autoflows: State$c;
+    autoflows: State$6;
     conversation: State$b;
     contentTypes: State$a;
     customMessages: State$9;
@@ -327,6 +327,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         insertLink: boolean;
         inlineSuggestions: boolean;
         adminUrl?: string | undefined;
+        productName: string;
     };
     profile: State$4;
     search: State$3;
@@ -342,9 +343,9 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
     textSuggestions: TextSuggestionState;
 }, redux.AnyAction, _reduxjs_toolkit.ThunkMiddleware<redux.CombinedState<{
     activeSuggestion: State$e;
-    answer: State$6;
+    answer: State$c;
     auth: State$d;
-    autoflows: State$c;
+    autoflows: State$6;
     conversation: State$b;
     contentTypes: State$a;
     customMessages: State$9;
@@ -386,6 +387,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         insertLink: boolean;
         inlineSuggestions: boolean;
         adminUrl?: string | undefined;
+        productName: string;
     };
     profile: State$4;
     search: State$3;
@@ -413,47 +415,6 @@ interface State$d {
     showLoginOverlay: boolean;
 }
 
-type Autoflow = CamelCaseKeys<Server$1.Autoflow> & {
-    isBusy?: boolean;
-};
-interface State$c {
-    list: Autoflow[];
-    fetchState: FetchState;
-    isInitialRequest: null | boolean;
-}
-
-interface State$b {
-    current: Conversation | null;
-    isSupported: boolean | null;
-}
-
-type ContentType = CamelCaseKeys<Server.ContentType>;
-type State$a = {
-    data: ContentType[] | null;
-    fetchState: FetchState;
-};
-
-type CustomMessage = CamelCaseKeys<Server$1.CustomMessage>;
-interface State$9 {
-    list: CustomMessage[];
-    fetchState: FetchState;
-    isInitialRequest: null | boolean;
-    sentSuggestions: string[];
-    errorSuggestions: string[];
-    answeredSuggestions: string[];
-}
-
-type State$8 = {
-    jwt: string | null;
-    accountUrl: string | null;
-    interval: NodeJS.Timer | null;
-};
-
-type State$7 = {
-    data: Entity[] | null;
-    fetchState: FetchState;
-};
-
 interface ListItemSource {
     url?: string;
     name: string;
@@ -461,15 +422,18 @@ interface ListItemSource {
 
 interface KnowledgeAnswer {
     answer: string;
-    timestamp: string;
     sources: ListItemSource[];
 }
 interface KnowledgeRequest {
+    promptInstruction: string;
+    question: string;
+}
+interface KnowledgeResponse {
     question: string;
     answer: KnowledgeAnswer;
 }
-type State$6 = {
-    data: KnowledgeRequest[];
+type State$c = {
+    data: KnowledgeResponse[];
     fetchState: FetchState;
 };
 
@@ -784,6 +748,7 @@ declare namespace Server {
         entities_command: boolean;
         summarizer: boolean;
         knowledge_search: boolean;
+        knowledge_search_prompt_instruction: string;
         ui_config: {
             widget: {
                 types: Array<{
@@ -799,7 +764,6 @@ declare namespace Server {
     type ChatHistory = {
         question: string;
         answer: string;
-        timestamp: string;
     };
 }
 type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'tags'>> & {
@@ -898,7 +862,6 @@ declare class DeepdeskAPI {
     options: DeepdeskAPIOptions;
     private latestReceivedDeepdeskVersions;
     client: HTTPClient;
-    account: string;
     shouldFetchCsrfToken: boolean;
     static exchangeTokenPromise: Promise<void> | null;
     private preflight;
@@ -918,13 +881,13 @@ declare class DeepdeskAPI {
      * Post converstation messages
      */
     postMessages(conversationId: string, messages: CamelCaseKeys<Server.ConversationMessage>[]): Promise<({
-        text: string;
         id: string;
         time: string;
         source: "agent" | "visitor" | "bot" | "system";
         authorId: string;
         authorName?: string | undefined;
         authorEmail?: string | undefined;
+        text: string;
     } & {
         tags: Record<string, string> | null;
     })[]>;
@@ -981,7 +944,7 @@ declare class DeepdeskAPI {
      * Search
      */
     search(params: SearchOptions): Promise<CamelCaseKeys<Server.SearchResultsData>>;
-    knowledgeSearch(question: string, chatHistory: KnowledgeRequest[], profile?: string): Promise<CamelCaseKeys<KnowledgeAnswer>>;
+    knowledgeSearch(request: KnowledgeRequest, chatHistory: KnowledgeResponse[], profile: string): Promise<CamelCaseKeys<KnowledgeAnswer>>;
     requestLoginByEmail(email: string): Promise<{
         code: string;
         message: string;
@@ -993,7 +956,48 @@ declare class DeepdeskAPI {
     private handleDeepdeskVersionHeaders;
 }
 
-declare const styles$l: {
+interface State$b {
+    current: Conversation | null;
+    isSupported: boolean | null;
+}
+
+type ContentType = CamelCaseKeys<Server.ContentType>;
+type State$a = {
+    data: ContentType[] | null;
+    fetchState: FetchState;
+};
+
+type CustomMessage = CamelCaseKeys<Server$1.CustomMessage>;
+interface State$9 {
+    list: CustomMessage[];
+    fetchState: FetchState;
+    isInitialRequest: null | boolean;
+    sentSuggestions: string[];
+    errorSuggestions: string[];
+    answeredSuggestions: string[];
+}
+
+type State$8 = {
+    jwt: string | null;
+    accountUrl: string | null;
+    interval: NodeJS.Timer | null;
+};
+
+type State$7 = {
+    data: Entity[] | null;
+    fetchState: FetchState;
+};
+
+type Autoflow = CamelCaseKeys<Server$1.Autoflow> & {
+    isBusy?: boolean;
+};
+interface State$6 {
+    list: Autoflow[];
+    fetchState: FetchState;
+    isInitialRequest: null | boolean;
+}
+
+declare const styles$m: {
   readonly "isDisabled": string;
   readonly "buttonStart": string;
   readonly "root": string;
@@ -1004,9 +1008,9 @@ declare const styles$l: {
   readonly "isAborted": string;
 };
 
-type AutoflowStyles = typeof styles$l;
+type AutoflowStyles = typeof styles$m;
 
-declare const styles$k: {
+declare const styles$l: {
   readonly "root": string;
   readonly "imageWrapper": string;
   readonly "image": string;
@@ -1035,9 +1039,19 @@ interface CardComposition {
     Content: FC<ContentProps>;
     Title: FC<TitleProps>;
 }
-type CardStyles = typeof styles$k;
+type CardStyles = typeof styles$l;
 declare const Card: FC & CardComposition;
 
+declare const styles$k: {
+  readonly "root": string;
+};
+
+interface Props$7 {
+    children: React.ReactNode;
+}
+type ChipStyles = typeof styles$k;
+declare const Chip: React.FC<Props$7>;
+
 declare const styles$j: {
   readonly "root": string;
   readonly "list": string;
@@ -1090,13 +1104,38 @@ type DialogStyles = typeof styles$i;
 
 declare const styles$h: {
   readonly "root": string;
+  readonly "content": string;
   readonly "title": string;
-  readonly "empty": string;
+  readonly "actions": string;
+  readonly "pagination": string;
+  readonly "primaryButton": string;
+  readonly "primaryButtons": string;
 };
 
-type EntitiesListStyles = typeof styles$h;
+type EditSuggestionFormStyles = typeof styles$h;
 
 declare const styles$g: {
+  readonly "root": string;
+  readonly "agentText": string;
+  readonly "textInput": string;
+  readonly "textInputWrapper": string;
+  readonly "alert": string;
+  readonly "alertText": string;
+  readonly "warning": string;
+  readonly "success": string;
+};
+
+type EditSuggestionTextInputStyles = typeof styles$g;
+
+declare const styles$f: {
+  readonly "root": string;
+  readonly "title": string;
+  readonly "empty": string;
+};
+
+type EntitiesListStyles = typeof styles$f;
+
+declare const styles$e: {
   readonly "root": string;
   readonly "isArrowUp": string;
   readonly "isArrowDown": string;
@@ -1112,37 +1151,37 @@ declare enum KeyboardHintKey {
     ESC = "esc",
     ENTER = "enter"
 }
-type Props$7 = HTMLAttributes<HTMLSpanElement> & {
+type Props$6 = HTMLAttributes<HTMLSpanElement> & {
     className?: string;
     keyCode: KeyboardHintKey;
 };
-type KeyboardHintStyles = typeof styles$g;
-declare const KeyboardHint: React.FC<Props$7>;
+type KeyboardHintStyles = typeof styles$e;
+declare const KeyboardHint: React.FC<Props$6>;
 
-declare const styles$f: {
+declare const styles$d: {
   readonly "root": string;
 };
 
-type Props$6 = HTMLAttributes<HTMLSpanElement>;
-type LabelStyles = typeof styles$f;
-declare const Label: React.FC<Props$6>;
+type Props$5 = HTMLAttributes<HTMLSpanElement>;
+type LabelStyles = typeof styles$d;
+declare const Label: React.FC<Props$5>;
 
-declare const styles$e: {
+declare const styles$c: {
   readonly "root": string;
   readonly "content": string;
 };
 
-type LinkSearchStyles = typeof styles$e;
+type LinkSearchStyles = typeof styles$c;
 
-declare const styles$d: {
+declare const styles$b: {
   readonly "root": string;
   readonly "anchor": string;
   readonly "anchorButton": string;
 };
 
-type LoginStyles = typeof styles$d;
+type LoginStyles = typeof styles$b;
 
-declare const styles$c: {
+declare const styles$a: {
   readonly "root": string;
   readonly "anchorButton": string;
   readonly "errorMessage": string;
@@ -1155,27 +1194,16 @@ declare const styles$c: {
   readonly "primaryButton": string;
 };
 
-type LoginTokenDialogStyles = typeof styles$c;
+type LoginTokenDialogStyles = typeof styles$a;
 
-declare const styles$b: {
+declare const styles$9: {
   readonly "root": string;
   readonly "text": string;
 };
 
-type SearchTriggerStyles = typeof styles$b;
-
-declare const styles$a: {
-  readonly "root": string;
-};
+type SearchTriggerStyles = typeof styles$9;
 
-type Props$5 = {
-    className?: string;
-    children?: React.ReactNode;
-};
-type SectionListStyles = typeof styles$a;
-declare const SectionList: React.ForwardRefExoticComponent<Props$5 & React.RefAttributes<HTMLDivElement>>;
-
-declare const styles$9: {
+declare const styles$8: {
   readonly "root": string;
   readonly "subTitleContainer": string;
   readonly "subtitle": string;
@@ -1185,35 +1213,19 @@ declare const styles$9: {
 type Props$4 = HTMLAttributes<HTMLElement> & {
     title?: string;
 };
-type SectionStyles = typeof styles$9;
+type SectionStyles = typeof styles$8;
 declare const Section: React.FC<Props$4>;
 
-declare const styles$8: {
-  readonly "root": string;
-  readonly "isWithDivider": string;
-};
-
-type SuggestionListStyles = typeof styles$8;
-interface Props$3 {
-    withDivider?: boolean;
-}
-declare const SuggestionList: React.FC<Props$3>;
-
 declare const styles$7: {
   readonly "root": string;
-  readonly "isInline": string;
-  readonly "toggleButton": string;
-  readonly "toggleButtonWrapper": string;
-  readonly "toggleButtonWrapperHidden": string;
-  readonly "isCollapsed": string;
-  readonly "collapsible": string;
-  readonly "hints": string;
-  readonly "hintsHidden": string;
-  readonly "triggers": string;
-  readonly "triggersRight": string;
 };
 
-type SuggestionsOverlayStyles = typeof styles$7;
+type Props$3 = {
+    className?: string;
+    children?: React.ReactNode;
+};
+type SectionListStyles = typeof styles$7;
+declare const SectionList: React.ForwardRefExoticComponent<Props$3 & React.RefAttributes<HTMLDivElement>>;
 
 declare const styles$6: {
   readonly "root": string;
@@ -1264,6 +1276,33 @@ type SuggestionStyles = typeof styles$6;
 declare const Suggestion: ForwardRefExoticComponent<Props$2 & RefAttributes<any>> & SuggestionComposition;
 
 declare const styles$5: {
+  readonly "root": string;
+  readonly "isWithDivider": string;
+};
+
+type SuggestionListStyles = typeof styles$5;
+interface Props$1 {
+    withDivider?: boolean;
+}
+declare const SuggestionList: React.FC<Props$1>;
+
+declare const styles$4: {
+  readonly "root": string;
+  readonly "isInline": string;
+  readonly "toggleButton": string;
+  readonly "toggleButtonWrapper": string;
+  readonly "toggleButtonWrapperHidden": string;
+  readonly "isCollapsed": string;
+  readonly "collapsible": string;
+  readonly "hints": string;
+  readonly "hintsHidden": string;
+  readonly "triggers": string;
+  readonly "triggersRight": string;
+};
+
+type SuggestionsOverlayStyles = typeof styles$4;
+
+declare const styles$3: {
   readonly "root": string;
   readonly "agentText": string;
   readonly "tabText": string;
@@ -1287,40 +1326,28 @@ declare const styles$5: {
   readonly "suggestionsOverlayInputStyles": string;
 };
 
-type TabCompletionStyles = typeof styles$5;
+type TabCompletionStyles = typeof styles$3;
 
-declare const styles$4: {
-  readonly "root": string;
-  readonly "content": string;
-  readonly "title": string;
-  readonly "actions": string;
-  readonly "pagination": string;
-  readonly "primaryButton": string;
-  readonly "primaryButtons": string;
-};
-
-type EditSuggestionFormStyles = typeof styles$4;
-
-declare const styles$3: {
+declare const styles$2: {
   readonly "badge": string;
   readonly "formattedText": string;
 };
 
-type TextSuggestionStyles = typeof styles$3;
+type TextSuggestionStyles = typeof styles$2;
 
-declare const styles$2: {
+declare const styles$1: {
   readonly "root": string;
   readonly "isCollapsed": string;
 };
 
-type Props$1 = HTMLAttributes<HTMLButtonElement> & {
+type Props = HTMLAttributes<HTMLButtonElement> & {
     isCollapsed: boolean;
     title: string;
 };
-type ToggleButtonStyles = typeof styles$2;
-declare const ToggleButton: React.FC<Props$1>;
+type ToggleButtonStyles = typeof styles$1;
+declare const ToggleButton: React.FC<Props>;
 
-declare const styles$1: {
+declare const styles: {
   readonly "root": string;
   readonly "loginText": string;
   readonly "stateText": string;
@@ -1329,17 +1356,7 @@ declare const styles$1: {
   readonly "link": string;
 };
 
-type WidgetStyles = typeof styles$1;
-
-declare const styles: {
-  readonly "root": string;
-};
-
-interface Props {
-    children: React.ReactNode;
-}
-type ChipStyles = typeof styles;
-declare const Chip: React.FC<Props>;
+type WidgetStyles = typeof styles;
 
 type WidgetCustomStyles = {
     Autoflow?: Partial<AutoflowStyles>;
@@ -1371,6 +1388,8 @@ type InputOverlayCustomStyles = {
     ToggleButton?: Partial<ToggleButtonStyles>;
     KeyboardHint?: Partial<KeyboardHintStyles>;
     TabCompletion?: Partial<TabCompletionStyles>;
+    EditSuggestionTextInput?: Partial<EditSuggestionTextInputStyles>;
+    EditSuggestionForm?: Partial<EditSuggestionFormStyles>;
 };
 declare enum Locale {
     NL_NL = "nl-NL",
@@ -1540,6 +1559,7 @@ declare enum SearchResultDefaultType {
 type SearchResult = SearchSuggestion;
 interface State$3 {
     list: Array<SearchResult>;
+    page: string;
     fetchState: FetchState;
     isOpen: boolean;
 }
@@ -1592,6 +1612,7 @@ type State = {
     insertLink: boolean;
     inlineSuggestions: boolean;
     adminUrl?: string;
+    productName: string;
 };
 declare const set: _reduxjs_toolkit.ActionCreatorWithPayload<Partial<State>, "settings/set">;
 
@@ -1608,6 +1629,7 @@ interface SDKOptions {
     locale?: Locale;
     token?: string;
     fetch?: typeof window.fetch;
+    productName?: string;
 }
 interface SDKEventMap {
     'select-suggestion': {
@@ -1615,6 +1637,7 @@ interface SDKEventMap {
         type: string;
         replace: SelectionRange;
         suggestion: TextSuggestion;
+        eventMetrics: SuggestionEventMetrics;
     };
     'reset': {
         text: string;
@@ -1679,12 +1702,12 @@ declare class DeepdeskSDK {
     instanceId: number;
     private shouldRender;
     store: Store;
-    constructor({ deepdeskUrl, brokerUrl, version, locale, token, fetch, }: SDKOptions);
+    constructor({ deepdeskUrl, brokerUrl, version, locale, token, fetch, productName, }: SDKOptions);
     get state(): redux.EmptyObject & {
         activeSuggestion: State$e;
-        answer: State$6;
+        answer: State$c;
         auth: State$d;
-        autoflows: State$c;
+        autoflows: State$6;
         conversation: State$b;
         contentTypes: State$a;
         customMessages: State$9;
@@ -1726,6 +1749,7 @@ declare class DeepdeskSDK {
             insertLink: boolean;
             inlineSuggestions: boolean;
             adminUrl?: string | undefined;
+            productName: string;
         };
         profile: State$4;
         search: State$3;
@@ -1767,6 +1791,7 @@ declare class DeepdeskSDK {
         insertLink: boolean;
         inlineSuggestions: boolean;
         adminUrl?: string | undefined;
+        productName: string;
     };
     get selectedTextSuggestion(): TextSuggestion;
     hasConversation(): boolean;
@@ -1989,6 +2014,7 @@ type PlatformConfig = {
     config: {
         account: {
             name: string;
+            url: string;
         };
         platform: {
             name: string;