@deepdesk/deepdesk-sdk 19.6.2-beta.15 → 19.6.2-beta.16

package/dist/index.d.mts

@@ -470,6 +470,13 @@ type State$8 = {
     }>;
     activeAssistantCode: string | null;
     nextLocalThreadId: number;
+    /** Evaluation ids suppressed after {@link clearDisplayedAnswers} so late chunks do not repopulate UI. */
+    suppressedEvaluationIds: 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;
@@ -2166,6 +2173,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;
@@ -2701,6 +2722,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.
      *
@@ -3733,4 +3854,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 };

package/dist/index.d.ts

@@ -470,6 +470,13 @@ type State$8 = {
     }>;
     activeAssistantCode: string | null;
     nextLocalThreadId: number;
+    /** Evaluation ids suppressed after {@link clearDisplayedAnswers} so late chunks do not repopulate UI. */
+    suppressedEvaluationIds: 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;
@@ -2166,6 +2173,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;
@@ -2701,6 +2722,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.
      *
@@ -3733,4 +3854,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 };