@deepdesk/deepdesk-sdk 19.6.2-beta.2 → 19.6.2-beta.21

package/dist/index.d.mts

@@ -406,7 +406,20 @@ declare enum FetchState {
     ERROR = "error"
 }
 
-interface State$a {
+type State$a = {
+    data: Profile | null;
+    fetchState: FetchState;
+    /** Bumped on reset/clear so in-flight getProfile cannot repopulate profile. */
+    generation: number;
+    inFlightRequestId: string | null;
+    /**
+     * Runtime-only UI override used by widget wrappers (e.g. to hide/show certain widget blocks
+     * via config.allowedWidgetTypes). Must not participate in async getProfile lifecycle.
+     */
+    widgetTypesOverride: Profile['uiConfig']['widget']['types'] | null;
+};
+
+interface State$9 {
     current: Conversation | null;
     isSupported: boolean | null;
 }
@@ -447,10 +460,28 @@ type AssistantInteraction = {
     };
     evaluationId: string;
 };
-type State$9 = {
+type State$8 = {
     cues: Cue[];
     threads: Record<number, AssistantInteraction[]>;
     pending: string[];
+    widgetAssistantSessionId: string | null;
+    assistantThreads: Record<string, {
+        threadId: number;
+    }>;
+    activeAssistantCode: string | null;
+    nextLocalThreadId: number;
+    /** Evaluation ids suppressed after {@link clearDisplayedAnswers} so late chunks do not repopulate UI. */
+    suppressedEvaluationIds: string[];
+    /**
+     * Silent parent cues (`evaluationId` + assistant code) that must not be recreated by a later
+     * websocket event. Child codes for the same evaluation stay allowed.
+     */
+    suppressedSilentParentKeys: string[];
+    /** Bumped on {@link clearDisplayedAnswers} so in-flight evaluateAssistant results are dropped. */
+    assistantDisplayGeneration: number;
+    pendingEvaluationGenerations: Record<string, number>;
+    pendingEvaluationAssistantCodes: Record<string, string>;
+    evaluationIdDisplayGeneration: Record<string, number>;
 };
 type Transcript = Array<{
     source: string;
@@ -467,8 +498,17 @@ interface EvaluateInput {
     includeMetadata?: boolean;
     externalConversationId?: string;
     skipState?: boolean;
+    silent?: boolean;
 }
 
+type QueueMicrotaskErrorEventData = {
+    message: string;
+    stack: string | null;
+    typeofQueueMicrotask: string;
+    typeofWindowQueueMicrotask: string;
+    typeofGlobalThisQueueMicrotask: string;
+};
+
 type Fetch = typeof window.fetch;
 type HTTPClientOptions = {
     fetch?: typeof window.fetch;
@@ -720,6 +760,8 @@ declare namespace Server {
     type EvaluationResponse = {
         evaluation_id: string;
         evaluation_status: EvaluationStatus;
+        session_id?: string;
+        is_silent?: boolean;
         output: EvaluationOutput | KAAnswer | string;
     };
     type EvaluationOutput = Array<{
@@ -869,6 +911,12 @@ declare namespace Server {
          */
         knowledge_assistant: string | null;
         knowledge_assistant_new: string | null;
+        widget_interactive_assistants: Array<{
+            code: string;
+            name: string;
+            display_name: string | null;
+            order: number;
+        }>;
         on_demand_assistants: Array<OnDemandAssistant>;
         active_config: {
             default_locale: string;
@@ -900,6 +948,7 @@ declare namespace Server {
         assistant_name: string;
         display_name?: string;
         is_pinned: boolean;
+        is_silent?: boolean;
     };
     type ChatHistory = {
         question: string;
@@ -1085,6 +1134,7 @@ type SendEventArgumentMap = {
     'trigger on demand assistant': Event$1<{
         assistantCode: string;
     }>;
+    'queueMicrotask error': Event$1<QueueMicrotaskErrorEventData>;
 };
 /**
  * Request retry options
@@ -1177,6 +1227,10 @@ declare class DeepdeskAPI {
      * Request autocomplete suggestions based on the agent text input
      */
     getAutocompleteSuggestions(conversationId: string, params: CamelCaseKeys<Server.GetAutocompleteSuggestionsParams>): Promise<TextSuggestion[]>;
+    /**
+     * Replace in-engine personal collection for the agent with items scoped to the conversation profile.
+     */
+    syncPersonalCollection(conversationId: string | number): Promise<void>;
     /**
      * Request pinned messages
      */
@@ -1223,11 +1277,31 @@ declare class DeepdeskAPI {
         externalConversationId?: string;
         attachments?: EvaluationAttachment[];
     }): Promise<CamelCaseKeys<Server.EvaluationResponse>>;
+    interactWithAssistant(init: {
+        assistantCode: string;
+        message: string;
+        sessionId?: string;
+        externalConversationId?: string;
+    }): Promise<CamelCaseKeys<Server.EvaluationResponse>>;
+    /**
+     * Clears the conversation of one assistant in a session, so the next `interactWithAssistant`
+     * call starts fresh. Other assistants in the same session keep their conversation.
+     */
+    resetAssistantThread(init: {
+        assistantCode: string;
+        sessionId: string;
+    }): Promise<void>;
+    /**
+     * @deprecated Prefer `interactWithAssistant` for widget chat. Kept for existing SDK consumers.
+     */
     createAssistantThread(init: {
         assistantCode: string;
     }): Promise<{
         id: number;
     }>;
+    /**
+     * @deprecated Prefer `interactWithAssistant` for widget chat. Kept for existing SDK consumers.
+     */
     postMessageToAssistantThread(init: {
         assistantCode: string;
         threadId: number;
@@ -1240,16 +1314,11 @@ declare class DeepdeskAPI {
 }
 
 type StyleSuggestion = CamelCaseKeys<Server.StyleSuggestion>;
-interface State$8 {
+interface State$7 {
     list: StyleSuggestion;
     fetchState: FetchState;
 }
 
-type State$7 = {
-    data: Profile | null;
-    fetchState: FetchState;
-};
-
 /**
  * A selection range representation for textarea's and contenteditables only using offsets.
  */
@@ -1419,9 +1488,9 @@ interface StoreConfig {
     preloadedState?: any;
 }
 declare const reducers: redux.Reducer<{
-    assistants: State$9;
+    assistants: State$8;
     auth: State$2;
-    conversation: State$a;
+    conversation: State$9;
     contentTypes: State$3;
     passwordlessToken: State$4;
     entities: State$1;
@@ -1473,9 +1542,9 @@ declare const reducers: redux.Reducer<{
         enableFeedbackForm: boolean;
         hasKeyboardInput: boolean;
     };
-    profile: State$7;
+    profile: State$a;
     search: State$b;
-    styleSuggestions: State$8;
+    styleSuggestions: State$7;
     ui: {
         showTabHint: boolean;
         inputHasFocus: boolean;
@@ -1485,9 +1554,9 @@ declare const reducers: redux.Reducer<{
     };
     textSuggestions: TextSuggestionState;
 }, redux.UnknownAction, Partial<{
-    assistants: State$9 | undefined;
+    assistants: State$8 | undefined;
     auth: State$2 | undefined;
-    conversation: State$a | undefined;
+    conversation: State$9 | undefined;
     contentTypes: State$3 | undefined;
     passwordlessToken: State$4 | undefined;
     entities: State$1 | undefined;
@@ -1539,9 +1608,9 @@ declare const reducers: redux.Reducer<{
         enableFeedbackForm: boolean;
         hasKeyboardInput: boolean;
     } | undefined;
-    profile: State$7 | undefined;
+    profile: State$a | undefined;
     search: State$b | undefined;
-    styleSuggestions: State$8 | undefined;
+    styleSuggestions: State$7 | undefined;
     ui: {
         showTabHint: boolean;
         inputHasFocus: boolean;
@@ -1552,9 +1621,9 @@ declare const reducers: redux.Reducer<{
     textSuggestions: TextSuggestionState | undefined;
 }>>;
 declare function createStore(config: StoreConfig): _reduxjs_toolkit.EnhancedStore<{
-    assistants: State$9;
+    assistants: State$8;
     auth: State$2;
-    conversation: State$a;
+    conversation: State$9;
     contentTypes: State$3;
     passwordlessToken: State$4;
     entities: State$1;
@@ -1606,9 +1675,9 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit.EnhancedStor
         enableFeedbackForm: boolean;
         hasKeyboardInput: boolean;
     };
-    profile: State$7;
+    profile: State$a;
     search: State$b;
-    styleSuggestions: State$8;
+    styleSuggestions: State$7;
     ui: {
         showTabHint: boolean;
         inputHasFocus: boolean;
@@ -1875,6 +1944,9 @@ type TextSuggestionStyles = typeof styles$3;
 declare const styles$2: {
   readonly "footer": string;
   readonly "footerShortcut": string;
+  readonly "interactiveAssistantTab": string;
+  readonly "interactiveAssistantTabActive": string;
+  readonly "interactiveAssistantTabs": string;
   readonly "link": string;
   readonly "loginText": string;
   readonly "root": string;
@@ -2007,6 +2079,7 @@ type State = {
     showTextSuggestions: boolean;
     showEntitiesCommand: boolean;
     showSummaryCommand: boolean;
+    /** @deprecated Use the knowledge-assist widget block; still synced from profile for legacy consumers. */
     showKnowledgeSearch: boolean;
     textSuggestionsCount: number;
     recommendTextSuggestions: boolean;
@@ -2106,6 +2179,20 @@ interface KnowledgeAssistOptions {
     };
 }
 type OpenAdminFeedbackHandler = (feedbackPath: string) => void | Promise<void>;
+/**
+ * Options for {@link DeepdeskSDK.reloadConversationContext}.
+ */
+type ReloadConversationContextOptions = {
+    /** Conversation payload from the host (same shape as {@link DeepdeskSDK.upsertConversation}). */
+    conversation: CreateConversation;
+    /** Optional visitor fields to apply when refreshing metadata on the same session. */
+    visitorInfo?: Partial<VisitorInfo>;
+    /**
+     * When `true`, clears on-screen assistant output after upsert (typical same-conversation refresh).
+     * Visitor info is applied after upsert (and after the UI clear when requested).
+     */
+    clearDisplayedUi?: boolean;
+};
 interface WidgetOptions {
     customStyles?: WidgetCustomStyles;
     showImages?: boolean;
@@ -2142,6 +2229,12 @@ declare class DeepdeskSDK {
     private floatingMenu;
     private widgetElement;
     private widgetRoot;
+    /** Shared DialogOverlays root (SearchOverlay / CMD+K). Owned by mount and/or renderWidget. */
+    private dialogOverlays;
+    /** First `customStyles` passed to {@link ensureDialogOverlays} wins for the shared root. */
+    private dialogOverlaysCustomStyles;
+    /** OR of includeLoginOverlay across ensureDialogOverlays callers (mount can upgrade widget-only). */
+    private dialogOverlaysIncludeLogin;
     private nicknameDialogUnsubscribe;
     private nicknameDialogFailed;
     private dynamicThunkObject;
@@ -2184,9 +2277,9 @@ declare class DeepdeskSDK {
      */
     constructor({ deepdeskUrl, version, locale, token, fetch, productName, createCustomChannel, websocketClient, }: SDKOptions);
     get state(): {
-        assistants: State$9;
+        assistants: State$8;
         auth: State$2;
-        conversation: State$a;
+        conversation: State$9;
         contentTypes: State$3;
         passwordlessToken: State$4;
         entities: State$1;
@@ -2238,9 +2331,9 @@ declare class DeepdeskSDK {
             enableFeedbackForm: boolean;
             hasKeyboardInput: boolean;
         };
-        profile: State$7;
+        profile: State$a;
         search: State$b;
-        styleSuggestions: State$8;
+        styleSuggestions: State$7;
         ui: {
             showTabHint: boolean;
             inputHasFocus: boolean;
@@ -2641,6 +2734,106 @@ declare class DeepdeskSDK {
      * ```
      */
     resetConversation(): void;
+    /**
+     * Clears on-screen assistant answers and related suggestion UI for the loaded
+     * conversation without unloading it from the store.
+     *
+     * **Preserved:** `conversation.current` (including `id`, `externalId`, and `metadata`),
+     * visitor info, profile configuration, and active handling-time tracking.
+     *
+     * **Reset:** assistant panels, text/style/search/pinned suggestions, entities, and input
+     * fields tied to displayed answers (same slices as after {@link resetConversation}, except
+     * `conversation.current` and handling-time state stay set).
+     *
+     * Does not re-fetch CRM data or post transcript messages. For a host-driven refresh,
+     * use {@link reloadConversationContext} with `clearDisplayedUi: true` and then
+     * {@link publishConversationTranscript}.
+     *
+     * **Integrators:** do not dispatch private store actions (for example
+     * `conversation/upsert/fulfilled`) to simulate a refresh; use the public methods above.
+     *
+     * No-op when no conversation is loaded.
+     *
+     * @example
+     * ```typescript
+     * // Same session, only wipe stale suggestions before reposting messages
+     * sdk.clearDisplayedAnswers();
+     * await sdk.publishConversationTranscript(messagesFromCrm);
+     * ```
+     */
+    clearDisplayedAnswers(): void;
+    /**
+     * Applies host-fetched conversation metadata to the current SDK session.
+     *
+     * Upserts via {@link upsertConversation} and optionally clears on-screen assistant UI.
+     * The host must fetch CRM (or other) data itself; this method does not load emails or
+     * transcript text. Call {@link publishConversationTranscript} afterward to push messages
+     * and refresh the conversation query.
+     *
+     * When `clearDisplayedUi` is `true`, {@link clearDisplayedAnswers} runs after the upsert.
+     * If `visitorInfo` is provided, it is applied after the upsert (and after the UI clear when
+     * requested). {@link clearDisplayedAnswers} does not clear visitor info; apply visitor info
+     * after upsert so it is not lost when upsert switches or resets conversation state.
+     *
+     * When switching to a different conversation, prefer {@link resetConversation} first,
+     * then load or upsert the new conversation.
+     *
+     * @param options - Host conversation payload and optional visitor / UI flags.
+     * @param options.conversation - Metadata to upsert (external id, platform, metadata, etc.).
+     * @param options.visitorInfo - Visitor fields to merge when refreshing the same session.
+     * @param options.clearDisplayedUi - Clear assistant/suggestion UI after upsert (default `false`).
+     *
+     * @example
+     * ```typescript
+     * const conversation = await fetchConversationFromCrm(caseId);
+     * const messages = await fetchEmailsFromCrm(caseId);
+     *
+     * await sdk.reloadConversationContext({
+     *   conversation,
+     *   visitorInfo: { visitorId: contactId, visitorName: contactName },
+     *   clearDisplayedUi: true,
+     * });
+     *
+     * // Optional: host-only widget state (assistant input, etc.)
+     * updateWidgetAssistantInput(...);
+     *
+     * await sdk.publishConversationTranscript(messages);
+     * ```
+     */
+    reloadConversationContext({ conversation, visitorInfo, clearDisplayedUi, }: ReloadConversationContextOptions): Promise<void>;
+    /**
+     * Publishes a host-built transcript for the current conversation.
+     *
+     * Sets the dynamic conversation query to the given messages and, when the array is
+     * non-empty, posts them through {@link postMessages}. Use after
+     * {@link reloadConversationContext} when the host already fetched the latest thread
+     * from an external system.
+     *
+     * @param messages - Transcript lines (`source`, `text`, and other {@link ConversationMessage} fields).
+     *
+     * @example
+     * ```typescript
+     * await sdk.publishConversationTranscript([
+     *   {
+     *     externalId: 'msg-1',
+     *     time: '2024-01-01T12:00:00Z',
+     *     source: 'visitor',
+     *     authorId: 'visitor-1',
+     *     text: 'Hello',
+     *     metadata: null,
+     *   },
+     *   {
+     *     externalId: 'msg-2',
+     *     time: '2024-01-01T12:01:00Z',
+     *     source: 'agent',
+     *     authorId: 'agent-1',
+     *     text: 'Hi, how can I help?',
+     *     metadata: null,
+     *   },
+     * ]);
+     * ```
+     */
+    publishConversationTranscript(messages: ConversationMessage[]): Promise<void>;
     /**
      * Updates SDK configuration settings.
      *
@@ -2663,7 +2856,8 @@ declare class DeepdeskSDK {
      * @param settings.showTextSuggestions: Show text suggestions (default: true)
      * @param settings.showEntitiesCommand: Show entities command (default: false)
      * @param settings.showSummaryCommand: Show summary command (default: false)
-     * @param settings.showKnowledgeSearch: Show knowledge search (default: false)
+     * @param settings.showKnowledgeSearch: @deprecated Use the knowledge-assist widget block instead.
+     *     Still accepted for backward compatibility; profile load overwrites this from {@link deriveShowKnowledgeSearch}.
      * @param settings.textSuggestionsCount: Number of text suggestions to show (default: 3)
      * @param settings.recommendTextSuggestions: Recommend text suggestions (default: true)
      * @param settings.searchTriggerKey: Key to trigger search (default: 'k')
@@ -3336,6 +3530,17 @@ declare class DeepdeskSDK {
     private renderInlineSuggestions;
     private renderAboveOrBelowSuggestions;
     private renderFloatingMenu;
+    /**
+     * Mount DialogOverlays (SearchOverlay / CMD+K) once per SDK instance.
+     * Used by both {@link mount} and {@link renderWidget} so iframe-only widgets
+     * (Content Guru, Dimelo) get search without attaching to a host input.
+     *
+     * `customStyles`: first caller wins (later `mount` / `renderWidget` styles are ignored).
+     * `includeLoginOverlay`: OR'd across callers — `mount` can upgrade a widget-only root
+     * by re-rendering into the **existing** React root (preserves SearchOverlay local state).
+     */
+    private ensureDialogOverlays;
+    private disposeDialogOverlays;
     private renderOverlays;
     /**
      * Renders the Deepdesk widget in a container element.
@@ -3347,6 +3552,11 @@ declare class DeepdeskSDK {
      * **Important:** Make sure to set the container element to a fixed or minimum size
      * (height and width) as the widget will grow to fill the container.
      *
+     * Also mounts dialog overlays (search command palette / CMD+K) so iframe-only
+     * integrations that never call {@link mount} still get search. Shared with `mount()` —
+     * only one overlays root exists per SDK instance. Does **not** mount `LoginOverlay`
+     * (iframe apps use their own sign-in); `mount()` still can.
+     *
      * **Note:** Only one widget can be rendered per SDK instance.
      *
      * @param containerElement - Element to render widget in
@@ -3458,6 +3668,22 @@ declare class DeepdeskSDK {
     private setupHandlingTime;
     private handleError;
     private loadProfileConfigPromise;
+    private loadProfileConfigPromiseKey;
+    private personalCollectionSyncPendingKey;
+    private personalCollectionSyncDrainPromise;
+    /**
+     * Subscription/dedupe key for conversation + profile. Admin validates profile codes as
+     * `[a-z0-9-]+` (no colon), so the last `:` separates conversation id from profileCode
+     * even when the id contains `:`.
+     */
+    private getConversationProfileKey;
+    private getProfileLoadKey;
+    private isCurrentProfileLoadKey;
+    private getConversationLoadedKey;
+    private resetProfileDerivedSettings;
+    private syncPersonalCollectionForConversation;
+    private ensurePersonalCollectionSyncDrain;
+    private drainPersonalCollectionSync;
     private loadProfileConfig;
     /**
      * Authenticates user via popup window.
@@ -3656,4 +3882,4 @@ declare function logEvent<T extends keyof SendEventArgumentMap>(event: LogEvent<
 type CSSModule = Record<string, string>;
 declare function useStyles<TStyles extends CSSModule>(componentName: string, defaultStyles: TStyles): TStyles;
 
-export { type AgentInfo, Card, ContentEditableInput, type Conversation, type ConversationAssistantResult, type ConversationMessage, DeepdeskAPI, DeepdeskSDK, type EvaluationAttachment, HTTPClient, InputMediator, type InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, type Logger, type MountOptions, type OpenAdminFeedbackHandler, type PinnedMessage, type PlatformConfig, type RootState, Section, SectionList, type SelectionRange, Sources, Suggestion, type SuggestionEventMetrics, SuggestionList, type SuggestionMetrics, TextAreaInput, type TextSuggestion, ToggleButton, type UrlSuggestion, type VisitorInfo, type WidgetCustomStyles, type WidgetOptions, attachFile, authenticateWithKey, createFullRange, createOverlayContainer, createRangeFromOffsets, escapeHTML, formatTextMarkup, getRangeOffsets, getRangeText, insertCKEditor, isHTML, isSupportedInputElement, logEvent, updateContentEditable, updateTextArea, useClickOutsideRoot, useStyles, waitForElementVisibilityChange };
+export { type AgentInfo, Card, ContentEditableInput, type Conversation, type ConversationAssistantResult, type ConversationMessage, DeepdeskAPI, DeepdeskSDK, type EvaluationAttachment, HTTPClient, InputMediator, type InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, type Logger, type MountOptions, type OpenAdminFeedbackHandler, type PinnedMessage, type PlatformConfig, type ReloadConversationContextOptions, type RootState, Section, SectionList, type SelectionRange, Sources, Suggestion, type SuggestionEventMetrics, SuggestionList, type SuggestionMetrics, TextAreaInput, type TextSuggestion, ToggleButton, type UrlSuggestion, type VisitorInfo, type WidgetCustomStyles, type WidgetOptions, attachFile, authenticateWithKey, createFullRange, createOverlayContainer, createRangeFromOffsets, escapeHTML, formatTextMarkup, getRangeOffsets, getRangeText, insertCKEditor, isHTML, isSupportedInputElement, logEvent, updateContentEditable, updateTextArea, useClickOutsideRoot, useStyles, waitForElementVisibilityChange };