@deepdesk/deepdesk-sdk 10.12.1-beta.1 → 10.12.1-beta.11

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import * as _reduxjs_toolkit_dist_configureStore from '@reduxjs/toolkit/dist/con
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
 import { Middleware } from '@reduxjs/toolkit';
 
-declare const styles$n: {
+declare const styles$l: {
   readonly "root": string;
   readonly "imageWrapper": string;
   readonly "image": string;
@@ -12,6 +12,7 @@ declare const styles$n: {
   readonly "title": string;
   readonly "contentIsCropped": string;
   readonly "lineClamp": string;
+  readonly "closeIcon": string;
 };
 
 type ImageProps = {
@@ -28,15 +29,19 @@ interface TitleProps extends React.HTMLProps<HTMLHeadingElement> {
     className?: string;
     as?: string;
 }
+interface CloseIconProps extends React.HTMLProps<HTMLDivElement> {
+    className?: string;
+}
 interface CardComposition {
     Image: FC<ImageProps>;
     Content: FC<ContentProps>;
     Title: FC<TitleProps>;
+    CloseIcon: FC<CloseIconProps>;
 }
-type CardStyles = typeof styles$n;
+type CardStyles = typeof styles$l;
 declare const Card: FC & CardComposition;
 
-declare const styles$m: {
+declare const styles$k: {
   readonly "root": string;
 };
 
@@ -51,18 +56,18 @@ type Props$6 = HTMLAttributes<HTMLSpanElement> & {
     className?: string;
     keyCode: KeyboardHintKey;
 };
-type KeyboardHintStyles = typeof styles$m;
+type KeyboardHintStyles = typeof styles$k;
 declare const KeyboardHint: React.FC<Props$6>;
 
-declare const styles$l: {
+declare const styles$j: {
   readonly "root": string;
 };
 
 type Props$5 = HTMLAttributes<HTMLSpanElement>;
-type LabelStyles = typeof styles$l;
+type LabelStyles = typeof styles$j;
 declare const Label: React.FC<Props$5>;
 
-declare const styles$k: {
+declare const styles$i: {
   readonly "root": string;
   readonly "subTitleContainer": string;
   readonly "subtitle": string;
@@ -73,10 +78,10 @@ type Props$4 = HTMLAttributes<HTMLElement> & {
     type: string;
     title?: string;
 };
-type SectionStyles = typeof styles$k;
+type SectionStyles = typeof styles$i;
 declare const Section: React.FC<Props$4>;
 
-declare const styles$j: {
+declare const styles$h: {
   readonly "root": string;
 };
 
@@ -84,10 +89,10 @@ type Props$3 = {
     className?: string;
     children?: React.ReactNode;
 };
-type SectionListStyles = typeof styles$j;
+type SectionListStyles = typeof styles$h;
 declare const SectionList: React.ForwardRefExoticComponent<Props$3 & React.RefAttributes<HTMLDivElement>>;
 
-declare const styles$i: {
+declare const styles$g: {
   readonly "root": string;
   readonly "fadein": string;
   readonly "isClickable": string;
@@ -132,21 +137,21 @@ interface SuggestionComposition {
     DropdownItem: FC<DropdownItemProps>;
     Labels: FC<LabelProps>;
 }
-type SuggestionStyles = typeof styles$i;
+type SuggestionStyles = typeof styles$g;
 declare const Suggestion: ForwardRefExoticComponent<Props$2 & RefAttributes<any>> & SuggestionComposition;
 
-declare const styles$h: {
+declare const styles$f: {
   readonly "root": string;
   readonly "isWithDivider": string;
 };
 
-type SuggestionListStyles = typeof styles$h;
+type SuggestionListStyles = typeof styles$f;
 interface Props$1 {
     withDivider?: boolean;
 }
 declare const SuggestionList: React.FC<Props$1>;
 
-declare const styles$g: {
+declare const styles$e: {
   readonly "root": string;
   readonly "isCollapsed": string;
 };
@@ -155,7 +160,7 @@ type Props = HTMLAttributes<HTMLButtonElement> & {
     isCollapsed: boolean;
     title: string;
 };
-type ToggleButtonStyles = typeof styles$g;
+type ToggleButtonStyles = typeof styles$e;
 declare const ToggleButton: React.FC<Props>;
 
 declare enum Sources {
@@ -279,11 +284,6 @@ type State$g = {
     stopTime: Date | null;
 };
 
-interface State$f {
-    contentType: string | null;
-    suggestion: TextSuggestion | null;
-}
-
 /**
  * CamelCase type manipulation
  * ```
@@ -451,16 +451,15 @@ interface StoreConfig {
     preloadedState?: any;
 }
 declare const reducers: redux.Reducer<redux.CombinedState<{
-    activeSuggestion: State$f;
-    answer: State$6;
-    auth: State$e;
-    autoflows: State$d;
-    conversation: State$c;
-    contentTypes: State$b;
-    customMessages: State$a;
-    passwordlessToken: State$9;
-    entities: State$8;
-    knowledgeAssistant: State$7;
+    answer: State$7;
+    auth: State$f;
+    autoflows: State$e;
+    conversation: State$d;
+    contentTypes: State$c;
+    customMessages: State$b;
+    passwordlessToken: State$a;
+    entities: State$9;
+    knowledgeAssistant: State$8;
     handlingTime: State$g;
     info: {
         agentInfo?: AgentInfo | undefined;
@@ -468,8 +467,7 @@ declare const reducers: redux.Reducer<redux.CombinedState<{
         visitorInfo?: VisitorInfo | undefined;
         fetchState: FetchState;
     };
-    input: State$5;
-    overlayInput: State$5;
+    input: State$6;
     settings: {
         locale: Locale;
         deanonymize: boolean;
@@ -500,10 +498,10 @@ declare const reducers: redux.Reducer<redux.CombinedState<{
         productName: string;
         suggestionFeedbackEmailAddresses?: string[] | undefined;
     };
-    profile: State$4;
-    search: State$3;
-    summary: State$2;
-    styleSuggestions: State$1;
+    profile: State$5;
+    search: State$4;
+    summary: State$3;
+    styleSuggestions: State$2;
     ui: {
         showTabHint: boolean;
         inputHasFocus: boolean;
@@ -511,19 +509,19 @@ declare const reducers: redux.Reducer<redux.CombinedState<{
         openOverlayWhenTyping: boolean;
         overlayCollapsedUserOverwrite: boolean;
     };
+    rules: State$1;
     textSuggestions: TextSuggestionState;
 }>, redux.AnyAction>;
 declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configureStore.ToolkitStore<redux.EmptyObject & {
-    activeSuggestion: State$f;
-    answer: State$6;
-    auth: State$e;
-    autoflows: State$d;
-    conversation: State$c;
-    contentTypes: State$b;
-    customMessages: State$a;
-    passwordlessToken: State$9;
-    entities: State$8;
-    knowledgeAssistant: State$7;
+    answer: State$7;
+    auth: State$f;
+    autoflows: State$e;
+    conversation: State$d;
+    contentTypes: State$c;
+    customMessages: State$b;
+    passwordlessToken: State$a;
+    entities: State$9;
+    knowledgeAssistant: State$8;
     handlingTime: State$g;
     info: {
         agentInfo?: AgentInfo | undefined;
@@ -531,8 +529,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         visitorInfo?: VisitorInfo | undefined;
         fetchState: FetchState;
     };
-    input: State$5;
-    overlayInput: State$5;
+    input: State$6;
     settings: {
         locale: Locale;
         deanonymize: boolean;
@@ -563,10 +560,10 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         productName: string;
         suggestionFeedbackEmailAddresses?: string[] | undefined;
     };
-    profile: State$4;
-    search: State$3;
-    summary: State$2;
-    styleSuggestions: State$1;
+    profile: State$5;
+    search: State$4;
+    summary: State$3;
+    styleSuggestions: State$2;
     ui: {
         showTabHint: boolean;
         inputHasFocus: boolean;
@@ -574,18 +571,18 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         openOverlayWhenTyping: boolean;
         overlayCollapsedUserOverwrite: boolean;
     };
+    rules: State$1;
     textSuggestions: TextSuggestionState;
 }, redux.AnyAction, _reduxjs_toolkit.ThunkMiddleware<redux.CombinedState<{
-    activeSuggestion: State$f;
-    answer: State$6;
-    auth: State$e;
-    autoflows: State$d;
-    conversation: State$c;
-    contentTypes: State$b;
-    customMessages: State$a;
-    passwordlessToken: State$9;
-    entities: State$8;
-    knowledgeAssistant: State$7;
+    answer: State$7;
+    auth: State$f;
+    autoflows: State$e;
+    conversation: State$d;
+    contentTypes: State$c;
+    customMessages: State$b;
+    passwordlessToken: State$a;
+    entities: State$9;
+    knowledgeAssistant: State$8;
     handlingTime: State$g;
     info: {
         agentInfo?: AgentInfo | undefined;
@@ -593,8 +590,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         visitorInfo?: VisitorInfo | undefined;
         fetchState: FetchState;
     };
-    input: State$5;
-    overlayInput: State$5;
+    input: State$6;
     settings: {
         locale: Locale;
         deanonymize: boolean;
@@ -625,10 +621,10 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         productName: string;
         suggestionFeedbackEmailAddresses?: string[] | undefined;
     };
-    profile: State$4;
-    search: State$3;
-    summary: State$2;
-    styleSuggestions: State$1;
+    profile: State$5;
+    search: State$4;
+    summary: State$3;
+    styleSuggestions: State$2;
     ui: {
         showTabHint: boolean;
         inputHasFocus: boolean;
@@ -636,6 +632,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         openOverlayWhenTyping: boolean;
         overlayCollapsedUserOverwrite: boolean;
     };
+    rules: State$1;
     textSuggestions: TextSuggestionState;
 }>, redux.AnyAction, {
     dynamicThunkObject: Record<string, unknown> | undefined;
@@ -645,7 +642,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
 type RootState = ReturnType<typeof reducers>;
 type Store = ReturnType<typeof createStore>;
 
-interface State$e {
+interface State$f {
     isLoggedIn: boolean | null;
     loginFetchState: FetchState;
     verifyFetchState: FetchState;
@@ -655,25 +652,25 @@ interface State$e {
 type Autoflow = CamelCaseKeys<Server$1.Autoflow> & {
     isBusy?: boolean;
 };
-interface State$d {
+interface State$e {
     list: Autoflow[];
     fetchState: FetchState;
     isInitialRequest: null | boolean;
 }
 
-interface State$c {
+interface State$d {
     current: Conversation | null;
     isSupported: boolean | null;
 }
 
 type ContentType = CamelCaseKeys<Server.ContentType>;
-type State$b = {
+type State$c = {
     data: ContentType[] | null;
     fetchState: FetchState;
 };
 
 type CustomMessage = CamelCaseKeys<Server$1.CustomMessage>;
-interface State$a {
+interface State$b {
     list: CustomMessage[];
     fetchState: FetchState;
     isInitialRequest: null | boolean;
@@ -682,18 +679,18 @@ interface State$a {
     answeredSuggestions: string[];
 }
 
-type State$9 = {
+type State$a = {
     token: string | null;
     accountUrl: string | null;
     interval: NodeJS.Timer | null;
 };
 
-type State$8 = {
+type State$9 = {
     data: Entity[] | null;
     fetchState: FetchState;
 };
 
-type State$7 = {
+type State$8 = {
     data: KnowledgeAssistant | null;
     fetchState: FetchState;
 };
@@ -715,7 +712,7 @@ interface KnowledgeResponse {
     question: string;
     answer: KnowledgeAnswer;
 }
-type State$6 = {
+type State$7 = {
     data: KnowledgeResponse[];
     fetchState: FetchState;
 };
@@ -1040,6 +1037,9 @@ declare namespace Server {
         summarizer_model: string;
         summarizer_assistant?: string;
         knowledge_assistant: string;
+        active_config: {
+            default_locale: string;
+        };
         ui_config: {
             widget: {
                 types: Array<{
@@ -1192,8 +1192,8 @@ declare class DeepdeskAPI {
      * Post converstation messages
      */
     postMessages(conversationId: string, messages: CamelCaseKeys<Server.ConversationMessage>[]): Promise<({
-        id: string;
         text: string;
+        id: string;
         source: "agent" | "visitor" | "bot" | "system";
         time: string;
         authorId: string;
@@ -1276,6 +1276,7 @@ declare class DeepdeskAPI {
     evaluateRule<Payload = unknown>(label: string, conversationId: string, payload: Payload, opts?: {
         raiseForFailingConditions?: boolean;
     }): Promise<CamelCaseKeys<Server.Cue[]>>;
+    translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
     private handleDeepdeskVersionHeaders;
 }
 
@@ -1375,6 +1376,15 @@ type CreateConversation = {
     agentEmail?: string;
     tags?: Record<string, string> | null;
 };
+type TranslationRequest = {
+    targetLanguage: string;
+    messages: Array<string>;
+};
+type TranslationResponse = {
+    originalLanguage: string;
+    targetLanguage: string;
+    translations: Array<string>;
+};
 interface Entity {
     text: string;
     label: string;
@@ -1420,7 +1430,7 @@ type MetricState = {
     textSuggestions: SuggestionMetrics[];
     cuts: any[];
 };
-type State$5 = {
+type State$6 = {
     text: string;
     html: string | null;
     selection: SelectionRange;
@@ -1436,7 +1446,7 @@ type State$5 = {
     selectedSuggestionIndex: number;
 };
 
-type State$4 = {
+type State$5 = {
     data: Profile | null;
     fetchState: FetchState;
 };
@@ -1450,7 +1460,7 @@ declare enum SearchResultDefaultType {
 }
 type SearchResultType = string | SearchResultDefaultType;
 type SearchResult = SearchSuggestion;
-interface State$3 {
+interface State$4 {
     list: Array<SearchResult>;
     page: string;
     fetchState: FetchState;
@@ -1458,18 +1468,26 @@ interface State$3 {
     aggregates: Record<string, number>;
 }
 
-type State$2 = {
+type State$3 = {
     data: string | null;
     fetchState: FetchState;
 };
 
 type StyleSuggestion = CamelCaseKeys<Server.StyleSuggestion>;
-interface State$1 {
+interface State$2 {
     list: StyleSuggestion;
     fetchState: FetchState;
     isInitialRequest: null | boolean;
 }
 
+type Cue = CamelCaseKeys<Server.Cue> & {
+    timestamp?: number;
+};
+type State$1 = {
+    cues: Cue[];
+    fetchState: FetchState;
+};
+
 type SuggestionState = {
     suggestions: TextSuggestion[];
     fetchState: FetchState;
@@ -1479,7 +1497,7 @@ interface TextSuggestionState {
     [type: string]: SuggestionState;
 }
 
-declare const styles$f: {
+declare const styles$d: {
   readonly "isDisabled": string;
   readonly "buttonStart": string;
   readonly "root": string;
@@ -1490,9 +1508,9 @@ declare const styles$f: {
   readonly "isAborted": string;
 };
 
-type AutoflowStyles = typeof styles$f;
+type AutoflowStyles = typeof styles$d;
 
-declare const styles$e: {
+declare const styles$c: {
   readonly "root": string;
   readonly "list": string;
   readonly "listWrapper": string;
@@ -1538,39 +1556,14 @@ declare const styles$e: {
   readonly "actionShortcutFixKerning": string;
 };
 
-type CommandPaletteStyles = typeof styles$e;
-
-declare const styles$d: {
-  readonly "root": string;
-  readonly "content": string;
-};
-
-type DialogStyles = typeof styles$d;
-
-declare const styles$c: {
-  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$c;
+type CommandPaletteStyles = typeof styles$c;
 
 declare const styles$b: {
   readonly "root": string;
-  readonly "agentText": string;
-  readonly "textInput": string;
-  readonly "textInputWrapper": string;
-  readonly "alert": string;
-  readonly "alertText": string;
-  readonly "warning": string;
-  readonly "success": string;
+  readonly "content": string;
 };
 
-type EditSuggestionTextInputStyles = typeof styles$b;
+type DialogStyles = typeof styles$b;
 
 declare const styles$a: {
   readonly "root": string;
@@ -1711,7 +1704,6 @@ type WidgetCustomStyles = {
     SectionList?: Partial<SectionListStyles>;
     Suggestion?: Partial<SuggestionStyles>;
     SuggestionList?: Partial<SuggestionListStyles>;
-    EditSuggestionForm?: Partial<EditSuggestionFormStyles>;
     Widget?: Partial<WidgetStyles>;
 };
 type InputOverlayCustomStyles = {
@@ -1729,8 +1721,6 @@ type InputOverlayCustomStyles = {
     ToggleButton?: Partial<ToggleButtonStyles>;
     KeyboardHint?: Partial<KeyboardHintStyles>;
     TabCompletion?: Partial<TabCompletionStyles>;
-    EditSuggestionTextInput?: Partial<EditSuggestionTextInputStyles>;
-    EditSuggestionForm?: Partial<EditSuggestionFormStyles>;
     FloatingMenu?: Partial<FloatingMenuStyles>;
 };
 
@@ -1806,6 +1796,7 @@ interface SDKEventMap {
         text: string;
         selectionAfter: SelectionRange;
     };
+    'cues': Cue[];
     'replace': {
         text: string;
         replace: SelectionRange;
@@ -1873,16 +1864,15 @@ declare class DeepdeskSDK {
     store: Store;
     constructor({ deepdeskUrl, brokerUrl, version, locale, token, fetch, productName, createCustomChannel, }: SDKOptions);
     get state(): redux.EmptyObject & {
-        activeSuggestion: State$f;
-        answer: State$6;
-        auth: State$e;
-        autoflows: State$d;
-        conversation: State$c;
-        contentTypes: State$b;
-        customMessages: State$a;
-        passwordlessToken: State$9;
-        entities: State$8;
-        knowledgeAssistant: State$7;
+        answer: State$7;
+        auth: State$f;
+        autoflows: State$e;
+        conversation: State$d;
+        contentTypes: State$c;
+        customMessages: State$b;
+        passwordlessToken: State$a;
+        entities: State$9;
+        knowledgeAssistant: State$8;
         handlingTime: State$g;
         info: {
             agentInfo?: AgentInfo | undefined;
@@ -1890,8 +1880,7 @@ declare class DeepdeskSDK {
             visitorInfo?: VisitorInfo | undefined;
             fetchState: FetchState;
         };
-        input: State$5;
-        overlayInput: State$5;
+        input: State$6;
         settings: {
             locale: Locale;
             deanonymize: boolean;
@@ -1922,10 +1911,10 @@ declare class DeepdeskSDK {
             productName: string;
             suggestionFeedbackEmailAddresses?: string[] | undefined;
         };
-        profile: State$4;
-        search: State$3;
-        summary: State$2;
-        styleSuggestions: State$1;
+        profile: State$5;
+        search: State$4;
+        summary: State$3;
+        styleSuggestions: State$2;
         ui: {
             showTabHint: boolean;
             inputHasFocus: boolean;
@@ -1933,6 +1922,7 @@ declare class DeepdeskSDK {
             openOverlayWhenTyping: boolean;
             overlayCollapsedUserOverwrite: boolean;
         };
+        rules: State$1;
         textSuggestions: TextSuggestionState;
     };
     get settings(): {
@@ -2055,18 +2045,13 @@ declare class DeepdeskSDK {
     private notifyPaste;
     private notifyCut;
     notifyExternalSuggestion(suggestion: StageSuggestion): void;
-    notifyEditSuggestion(data: {
-        contentType: string;
-        suggestions: TextSuggestion[];
-        index: number | null;
-    }): void;
+    evaluateRule(label: string, params?: Record<string, any>): Promise<any>;
     private handleInputChanged;
     private handleKeyDown;
     private handleAfterSendMessage;
     handlingTimeStart(): void;
     handlingTimeStop(): void;
     private logSendMessage;
-    private logSendEditMessage;
     private logHandlingTime;
     /**
      * Method to call when the agent has sent a message to the visitor
@@ -2126,6 +2111,7 @@ declare class DeepdeskSDK {
     loginViaPopup(options?: {
         url?: string;
     }): Promise<void>;
+    translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
     checkForTrialMode(agentId: string): Promise<void>;
     private refreshWidgetSuggestions;
 }