@deepdesk/deepdesk-sdk 14.1.1-beta.0 → 14.1.1-beta.10

package/dist/index.d.mts

@@ -292,7 +292,7 @@ declare abstract class InputMediator<HTMLElementType extends HTMLElement> {
     dispose(): void;
 }
 
-type State$h = {
+type State$g = {
     startTime: Date | null;
     stopTime: Date | null;
 };
@@ -458,10 +458,15 @@ declare class DeepdeskBrokerAPI {
 }
 
 type EvaluationOutput = CamelCaseKeys<Server.EvaluationOutput>;
-type State$g = {
+type State$f = {
     outputs: EvaluationOutput[];
     fetchState: FetchState;
 };
+type Transcript = Array<{
+    source: string;
+    text: string;
+}>;
+type TranscriptOption = 'in-memory-transcript' | 'stored-transcript' | Transcript;
 
 interface StoreConfig {
     deepdeskAPI: DeepdeskAPI;
@@ -471,17 +476,17 @@ interface StoreConfig {
     preloadedState?: any;
 }
 declare const reducers: redux.Reducer<redux.CombinedState<{
-    assistants: State$g;
-    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$h;
+    assistants: 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;
+    handlingTime: State$g;
     info: {
         agentInfo?: AgentInfo | undefined;
         agentSettings: unknown;
@@ -490,7 +495,7 @@ declare const reducers: redux.Reducer<redux.CombinedState<{
         platformVariables?: VariableMapping | undefined;
         fetchState: FetchState;
     };
-    input: State$6;
+    input: State$5;
     settings: {
         locale: Locale;
         deanonymize: boolean;
@@ -523,9 +528,8 @@ declare const reducers: redux.Reducer<redux.CombinedState<{
         enableFeedbackForm: boolean;
         hasKeyboardInput: boolean;
     };
-    profile: State$5;
-    search: State$4;
-    summary: State$3;
+    profile: State$4;
+    search: State$3;
     styleSuggestions: State$2;
     ui: {
         showTabHint: boolean;
@@ -538,17 +542,17 @@ declare const reducers: redux.Reducer<redux.CombinedState<{
     textSuggestions: TextSuggestionState;
 }>, redux.AnyAction>;
 declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configureStore.ToolkitStore<redux.EmptyObject & {
-    assistants: State$g;
-    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$h;
+    assistants: 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;
+    handlingTime: State$g;
     info: {
         agentInfo?: AgentInfo | undefined;
         agentSettings: unknown;
@@ -557,7 +561,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         platformVariables?: VariableMapping | undefined;
         fetchState: FetchState;
     };
-    input: State$6;
+    input: State$5;
     settings: {
         locale: Locale;
         deanonymize: boolean;
@@ -590,9 +594,8 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         enableFeedbackForm: boolean;
         hasKeyboardInput: boolean;
     };
-    profile: State$5;
-    search: State$4;
-    summary: State$3;
+    profile: State$4;
+    search: State$3;
     styleSuggestions: State$2;
     ui: {
         showTabHint: boolean;
@@ -604,17 +607,17 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
     rules: State$1;
     textSuggestions: TextSuggestionState;
 }, redux.AnyAction, _reduxjs_toolkit.ThunkMiddleware<redux.CombinedState<{
-    assistants: State$g;
-    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$h;
+    assistants: 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;
+    handlingTime: State$g;
     info: {
         agentInfo?: AgentInfo | undefined;
         agentSettings: unknown;
@@ -623,7 +626,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         platformVariables?: VariableMapping | undefined;
         fetchState: FetchState;
     };
-    input: State$6;
+    input: State$5;
     settings: {
         locale: Locale;
         deanonymize: boolean;
@@ -656,9 +659,8 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         enableFeedbackForm: boolean;
         hasKeyboardInput: boolean;
     };
-    profile: State$5;
-    search: State$4;
-    summary: State$3;
+    profile: State$4;
+    search: State$3;
     styleSuggestions: State$2;
     ui: {
         showTabHint: boolean;
@@ -677,7 +679,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
 type RootState = ReturnType<typeof reducers>;
 type Store = ReturnType<typeof createStore>;
 
-interface State$f {
+interface State$e {
     isLoggedIn: boolean | null;
     loginFetchState: FetchState;
     verifyFetchState: FetchState;
@@ -687,24 +689,24 @@ interface State$f {
 type Autoflow = CamelCaseKeys<Server$1.Autoflow> & {
     isBusy?: boolean;
 };
-interface State$e {
+interface State$d {
     list: Autoflow[];
     fetchState: FetchState;
 }
 
-interface State$d {
+interface State$c {
     current: Conversation | null;
     isSupported: boolean | null;
 }
 
 type ContentType = CamelCaseKeys<Server.ContentType>;
-type State$c = {
+type State$b = {
     data: ContentType[] | null;
     fetchState: FetchState;
 };
 
 type CustomMessage = CamelCaseKeys<Server$1.CustomMessage>;
-interface State$b {
+interface State$a {
     list: CustomMessage[];
     fetchState: FetchState;
     sentSuggestions: string[];
@@ -712,17 +714,17 @@ interface State$b {
     answeredSuggestions: string[];
 }
 
-type State$a = {
+type State$9 = {
     token: string | null;
     interval: NodeJS.Timer | null;
 };
 
-type State$9 = {
+type State$8 = {
     data: Entity[] | null;
     fetchState: FetchState;
 };
 
-type State$8 = {
+type State$7 = {
     data: KnowledgeAssistant | null;
     fetchState: FetchState;
 };
@@ -745,7 +747,7 @@ interface KnowledgeResponse {
     question: string;
     answer: KnowledgeAnswer;
 }
-type State$7 = {
+type State$6 = {
     data: KnowledgeResponse[];
     fetchState: FetchState;
 };
@@ -1001,15 +1003,22 @@ declare namespace Server {
         message: string;
         profile_code: string;
     }
+    interface CallToAction {
+        label: string;
+        event: string;
+        value: string;
+    }
     interface Cue {
         text: string;
         title: string;
         rule: Pick<Rule, 'id' | 'name' | 'label' | 'description'>;
+        call_to_action?: CallToAction;
     }
     interface EvaluationOutput {
         code: string;
         name: string;
         response: string;
+        call_to_action?: CallToAction;
     }
     /**
      * Handling time event data
@@ -1092,7 +1101,15 @@ declare namespace Server {
         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;
         knowledge_assistant: string;
         active_config: {
             default_locale: string;
@@ -1233,7 +1250,7 @@ type SendEventV2ArgumentMap = {
     }>;
     'conversation summarized': EventV2<{
         summary: string;
-        model?: string;
+        assistant?: string;
     }>;
     'style suggested': EventV2<{
         keywordMatches: {
@@ -1261,6 +1278,10 @@ type SendEventV2ArgumentMap = {
     'Assistant response copied': EventV2<RuleEventMeta & {
         copiedText: string;
     }>;
+    'Assistant call to action': EventV2<RuleEventMeta & {
+        eventName: string;
+        value: string;
+    }>;
     'summary feedback': EventV2<{
         summary: string;
         rating: 'up' | 'down';
@@ -1351,15 +1372,6 @@ declare class DeepdeskAPI {
     getEntities(messages: Array<{
         text: string;
     }>): Promise<Entity[]>;
-    getSummary(messages: Array<{
-        source: string;
-        text: string;
-    }>, options?: {
-        model?: string;
-        promptInstruction?: string;
-        agentId?: string;
-        externalConversationId?: string;
-    }): Promise<CamelCaseKeys<Server.Summary>>;
     /**
      * Get a temporary exchange / login token
      */
@@ -1416,9 +1428,27 @@ declare class DeepdeskAPI {
     evaluateRule<Payload = unknown>(label: string, conversationId: string, payload: Payload, opts?: {
         raiseForFailingConditions?: boolean;
     }): Promise<CamelCaseKeys<Server.Cue[]>>;
-    evaluateAssistant<TPayload = unknown>(assistantCode: string, payload: TPayload, options?: {
+    /**
+     * Temporarily restore getSummary for more controlled rollout
+     * @deprecated
+     */
+    getSummary(messages: Array<{
+        source: string;
+        text: string;
+    }>, options?: {
+        model?: string;
+        promptInstruction?: string;
+        agentId?: string;
+        externalConversationId?: string;
+    }): Promise<CamelCaseKeys<Server.Summary>>;
+    evaluateAssistant<TInput = Record<string, unknown>>(assistantCode: string, options: {
+        input: TInput;
+        transcript?: Array<{
+            source: string;
+            text: string;
+        }>;
         conversationId?: string;
-    }): Promise<CamelCaseKeys<Server.EvaluationOutput[]>>;
+    }): Promise<CamelCaseKeys<Server.EvaluationOutput[]> | string>;
     getRules(): Promise<CamelCaseKeys<Server.Rule[]>>;
     translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
     private handleDeepdeskVersionHeaders;
@@ -1590,7 +1620,7 @@ type MetricState = {
     textSuggestions: SuggestionMetrics[];
     cuts: any[];
 };
-type State$6 = {
+type State$5 = {
     text: string;
     html: string | null;
     selection: SelectionRange;
@@ -1605,7 +1635,7 @@ type State$6 = {
     selectedSuggestionIndex: number;
 };
 
-type State$5 = {
+type State$4 = {
     data: Profile | null;
     fetchState: FetchState;
 };
@@ -1619,7 +1649,7 @@ declare enum SearchResultDefaultType {
 }
 type SearchResultType = string | SearchResultDefaultType;
 type SearchResult = SearchSuggestion;
-interface State$4 {
+interface State$3 {
     list: Array<SearchResult>;
     page: string;
     fetchState: FetchState;
@@ -1627,12 +1657,6 @@ interface State$4 {
     aggregates: Record<string, number>;
 }
 
-type State$3 = {
-    data: string | null;
-    model?: string;
-    fetchState: FetchState;
-};
-
 type StyleSuggestion = CamelCaseKeys<Server.StyleSuggestion>;
 interface State$2 {
     list: StyleSuggestion;
@@ -1910,6 +1934,7 @@ declare const styles: {
   readonly "label": string;
   readonly "value": string;
   readonly "copyButton": string;
+  readonly "copyButtonText": string;
   readonly "isTrue": string;
   readonly "isFalse": string;
 };
@@ -2042,6 +2067,9 @@ interface SDKEventMap {
         name: string;
         data: unknown;
     };
+    'call-to-action': {
+        cue: Cue;
+    };
     logout: undefined;
     ready: undefined;
     showSearchOverlay: boolean;
@@ -2099,17 +2127,17 @@ declare class DeepdeskSDK {
     store: Store;
     constructor({ deepdeskUrl, brokerUrl, version, locale, token, fetch, productName, createCustomChannel, }: SDKOptions);
     get state(): redux.EmptyObject & {
-        assistants: State$g;
-        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$h;
+        assistants: 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;
+        handlingTime: State$g;
         info: {
             agentInfo?: AgentInfo | undefined;
             agentSettings: unknown;
@@ -2118,7 +2146,7 @@ declare class DeepdeskSDK {
             platformVariables?: VariableMapping | undefined;
             fetchState: FetchState;
         };
-        input: State$6;
+        input: State$5;
         settings: {
             locale: Locale;
             deanonymize: boolean;
@@ -2151,9 +2179,8 @@ declare class DeepdeskSDK {
             enableFeedbackForm: boolean;
             hasKeyboardInput: boolean;
         };
-        profile: State$5;
-        search: State$4;
-        summary: State$3;
+        profile: State$4;
+        search: State$3;
         styleSuggestions: State$2;
         ui: {
             showTabHint: boolean;
@@ -2241,10 +2268,6 @@ declare class DeepdeskSDK {
      * Reset conversation
      */
     resetConversation(): void;
-    /**
-     * Get summary from conversation
-     */
-    getSummary(): Promise<string>;
     /**
      * Change settings value
      */
@@ -2275,8 +2298,40 @@ declare class DeepdeskSDK {
      */
     refresh(): Promise<void>;
     notifyExternalSuggestion(suggestion: StageSuggestion): void;
+    /**
+     * @deprecated in favor of `evaluateAssistant`
+     */
     evaluateRule(label: string, params?: Record<string, any>, options?: EvaluateRuleOptions): Promise<Cue[]>;
-    evaluateAssistant(assistantCode: string, payload?: Record<string, any>): Promise<void>;
+    /**
+     * Evaluate assistant
+     * By default will show cues in widget
+     */
+    evaluateAssistant(assistantCode: string, options?: {
+        input?: Record<string, any>;
+        transcript?: TranscriptOption;
+        includeTags?: boolean;
+        showCuesInWidget?: boolean;
+    }): Promise<EvaluationOutput[] | string>;
+    /**
+     * @deprecated in favor of passing `payload` through `options` argument
+     * TODO: remove when integrations use first call signature
+     */
+    evaluateAssistant(assistantCode: string, payload?: Record<string, any>): Promise<EvaluationOutput[] | string>;
+    /**
+     * Evaluate conversation lifecycle assistant
+     * Convenient wrapper around `evaluateAssistant`.
+     * By default includes 'stored-transcript' and 'tags'.
+     */
+    evaluateConversationAssistant(event: 'accepted' | 'new-message' | 'ended', options?: {
+        input?: Record<string, any>;
+        transcript?: TranscriptOption;
+        includeTags?: boolean;
+        showCuesInWidget?: boolean;
+    }): Promise<void>;
+    /**
+     * Get summary from conversation
+     */
+    getSummary(): Promise<string | null>;
     private handleKeyDown;
     private handleAfterSendMessage;
     handlingTimeStart(): void;