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

package/dist/index.d.mts

@@ -451,6 +451,12 @@ type State$9 = {
     cues: Cue[];
     threads: Record<number, AssistantInteraction[]>;
     pending: string[];
+    widgetAssistantSessionId: string | null;
+    assistantThreads: Record<string, {
+        threadId: number;
+    }>;
+    activeAssistantCode: string | null;
+    nextLocalThreadId: number;
 };
 type Transcript = Array<{
     source: string;
@@ -469,6 +475,14 @@ interface EvaluateInput {
     skipState?: 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 +734,7 @@ declare namespace Server {
     type EvaluationResponse = {
         evaluation_id: string;
         evaluation_status: EvaluationStatus;
+        session_id?: string;
         output: EvaluationOutput | KAAnswer | string;
     };
     type EvaluationOutput = Array<{
@@ -869,6 +884,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;
@@ -1085,6 +1106,7 @@ type SendEventArgumentMap = {
     'trigger on demand assistant': Event$1<{
         assistantCode: string;
     }>;
+    'queueMicrotask error': Event$1<QueueMicrotaskErrorEventData>;
 };
 /**
  * Request retry options
@@ -1177,6 +1199,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 +1249,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;
@@ -1248,6 +1294,9 @@ interface State$8 {
 type State$7 = {
     data: Profile | null;
     fetchState: FetchState;
+    /** Bumped on reset/clear so in-flight getProfile cannot repopulate profile. */
+    generation: number;
+    inFlightRequestId: string | null;
 };
 
 /**
@@ -1875,6 +1924,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 +2059,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;
@@ -2663,7 +2716,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')
@@ -2806,6 +2860,28 @@ declare class DeepdeskSDK {
      * ```
      */
     getAgentSettings<T = unknown>(): Promise<T>;
+    /**
+     * Retrieves the currently logged-in agent's own Deepdesk profile.
+     *
+     * This is the agent's Deepdesk-side identity, including the display name
+     * (`nickname`) they configured in Studio under Profile settings. Platform
+     * integrations should prefer this `nickname` over any name supplied by the
+     * host platform (e.g. Genesys Cloud, LiveEngage) when populating
+     * `agentNickname` via `setAgentInfo`, since the agent's Deepdesk profile
+     * setting is the one they explicitly chose to expose to customers.
+     *
+     * @returns Promise that resolves to the agent's Deepdesk profile
+     *
+     * @example
+     * ```typescript
+     * const me = await sdk.getMe();
+     * await sdk.setAgentInfo({
+     *   agentId: platformAgent.id,
+     *   agentNickname: me.nickname || platformAgent.name,
+     * });
+     * ```
+     */
+    getMe(): Promise<CamelCaseKeys<Server.Me>>;
     /**
      * Refreshes suggestions based on the current conversation.
      *
@@ -3436,6 +3512,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.

package/dist/index.d.ts

@@ -451,6 +451,12 @@ type State$9 = {
     cues: Cue[];
     threads: Record<number, AssistantInteraction[]>;
     pending: string[];
+    widgetAssistantSessionId: string | null;
+    assistantThreads: Record<string, {
+        threadId: number;
+    }>;
+    activeAssistantCode: string | null;
+    nextLocalThreadId: number;
 };
 type Transcript = Array<{
     source: string;
@@ -469,6 +475,14 @@ interface EvaluateInput {
     skipState?: 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 +734,7 @@ declare namespace Server {
     type EvaluationResponse = {
         evaluation_id: string;
         evaluation_status: EvaluationStatus;
+        session_id?: string;
         output: EvaluationOutput | KAAnswer | string;
     };
     type EvaluationOutput = Array<{
@@ -869,6 +884,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;
@@ -1085,6 +1106,7 @@ type SendEventArgumentMap = {
     'trigger on demand assistant': Event$1<{
         assistantCode: string;
     }>;
+    'queueMicrotask error': Event$1<QueueMicrotaskErrorEventData>;
 };
 /**
  * Request retry options
@@ -1177,6 +1199,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 +1249,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;
@@ -1248,6 +1294,9 @@ interface State$8 {
 type State$7 = {
     data: Profile | null;
     fetchState: FetchState;
+    /** Bumped on reset/clear so in-flight getProfile cannot repopulate profile. */
+    generation: number;
+    inFlightRequestId: string | null;
 };
 
 /**
@@ -1875,6 +1924,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 +2059,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;
@@ -2663,7 +2716,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')
@@ -2806,6 +2860,28 @@ declare class DeepdeskSDK {
      * ```
      */
     getAgentSettings<T = unknown>(): Promise<T>;
+    /**
+     * Retrieves the currently logged-in agent's own Deepdesk profile.
+     *
+     * This is the agent's Deepdesk-side identity, including the display name
+     * (`nickname`) they configured in Studio under Profile settings. Platform
+     * integrations should prefer this `nickname` over any name supplied by the
+     * host platform (e.g. Genesys Cloud, LiveEngage) when populating
+     * `agentNickname` via `setAgentInfo`, since the agent's Deepdesk profile
+     * setting is the one they explicitly chose to expose to customers.
+     *
+     * @returns Promise that resolves to the agent's Deepdesk profile
+     *
+     * @example
+     * ```typescript
+     * const me = await sdk.getMe();
+     * await sdk.setAgentInfo({
+     *   agentId: platformAgent.id,
+     *   agentNickname: me.nickname || platformAgent.name,
+     * });
+     * ```
+     */
+    getMe(): Promise<CamelCaseKeys<Server.Me>>;
     /**
      * Refreshes suggestions based on the current conversation.
      *
@@ -3436,6 +3512,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.