@deepdesk/deepdesk-sdk 18.0.2 → 18.0.3-beta.1

package/dist/index.d.mts

@@ -896,6 +896,7 @@ type RuleEventMeta = {
     name: string;
     description: string;
     group: string;
+    evaluationId: string;
 };
 /**
  * Map the send event name to the data value in the payload
@@ -1127,7 +1128,10 @@ declare class DeepdeskAPI {
             text: string;
         }>;
         externalConversationId?: string;
-    }): Promise<CamelCaseKeys<Server.EvaluationOutput<TOutput>>>;
+    }): Promise<CamelCaseKeys<{
+        evaluation_id: string;
+        output: Server.EvaluationOutput<TOutput>;
+    }>>;
     createAssistantThread(init: {
         assistantCode: string;
     }): Promise<{
@@ -1316,6 +1320,7 @@ type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
     isLoading?: boolean;
     editable?: boolean;
     specialType?: 'summary';
+    evaluationId: string;
 };
 
 type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
@@ -1323,6 +1328,7 @@ type ArrayItemType<T> = T extends Array<infer I> ? I : never;
 type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
     isLoading?: boolean;
     specialType?: 'summary';
+    evaluationId: string;
 };
 type AssistantAnswerSource = {
     url?: string;
@@ -1334,6 +1340,7 @@ type AssistantInteraction = {
         answer: string;
         sources?: AssistantAnswerSource[];
     };
+    evaluationId: string;
 };
 type State$2 = {
     cues: Cue[];
@@ -2066,6 +2073,7 @@ declare class DeepdeskSDK {
     private broadcastEvents;
     private eventListeners;
     private unmountHandlers;
+    private disposeHandlers;
     private inlineSuggestions;
     private aboveSuggestions;
     private floatingMenu;
@@ -3133,6 +3141,7 @@ declare class DeepdeskSDK {
     setPlatformVariables(mapping: VariableMapping): void;
     /**
      * Registers a callback to be called when conversation is loaded.
+     * Convenient wrapper around `subscribe`.
      *
      * This method allows you to register a callback function that will be executed
      * when a conversation is successfully loaded. The callback is called after
@@ -3141,6 +3150,8 @@ declare class DeepdeskSDK {
      * If a conversation is already loaded when this method is called, the callback
      * will be executed immediately.
      *
+     * If the conversation changes, the callback will be called again.
+     *
      * @param callback - Function to call when conversation loads
      *
      * @example
@@ -3151,7 +3162,7 @@ declare class DeepdeskSDK {
      * });
      * ```
      */
-    whenConversationLoaded(callback: () => void): void;
+    whenConversationLoaded(callback: () => void): Unsubscribe;
     private overlayContainerFactory;
     private createInlineContainer;
     private createContainer;
@@ -3236,15 +3247,17 @@ declare class DeepdeskSDK {
      */
     subscribe<T>(selector: (state: RootState) => T, callback: (value: T) => void): Unsubscribe;
     /**
-     * Unmounts the SDK and cleans up all resources.
+     * Unmounts the SDK and cleans up all resources related to the mount() method.
      *
      * This method removes all UI components, event listeners, and cleans up
-     * internal resources. It should be called when you're done using the SDK
-     * or when you need to remount it on a different element.
+     * internal resources.
      *
      * After calling this method, the SDK instance can be reused by calling
      * `mount()` again on a new input element.
      *
+     * **Important:** This method does not clean up all DeepdeskSDK resources.
+     * Use `dispose()` to clean up all resources instead.
+     *
      * @example
      * ```typescript
      * // Unmount when switching conversations
@@ -3252,6 +3265,19 @@ declare class DeepdeskSDK {
      * ```
      */
     unmount(): void;
+    /**
+     * Disposes of the DeepdeskSDK instance.
+     *
+     * This method removes all UI components, event listeners, and cleans up
+     * internal resources. It should be called when you're done using the SDK.
+     *
+     * @example
+     * ```typescript
+     * // Dispose of DeepdeskSDK instance after conversation is unloaded
+     * sdk.dispose();
+     * ```
+     */
+    dispose(): void;
     private renderSuggestions;
     private renderInlineSuggestions;
     private renderAboveSuggestions;

package/dist/index.d.ts

@@ -896,6 +896,7 @@ type RuleEventMeta = {
     name: string;
     description: string;
     group: string;
+    evaluationId: string;
 };
 /**
  * Map the send event name to the data value in the payload
@@ -1127,7 +1128,10 @@ declare class DeepdeskAPI {
             text: string;
         }>;
         externalConversationId?: string;
-    }): Promise<CamelCaseKeys<Server.EvaluationOutput<TOutput>>>;
+    }): Promise<CamelCaseKeys<{
+        evaluation_id: string;
+        output: Server.EvaluationOutput<TOutput>;
+    }>>;
     createAssistantThread(init: {
         assistantCode: string;
     }): Promise<{
@@ -1316,6 +1320,7 @@ type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
     isLoading?: boolean;
     editable?: boolean;
     specialType?: 'summary';
+    evaluationId: string;
 };
 
 type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
@@ -1323,6 +1328,7 @@ type ArrayItemType<T> = T extends Array<infer I> ? I : never;
 type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
     isLoading?: boolean;
     specialType?: 'summary';
+    evaluationId: string;
 };
 type AssistantAnswerSource = {
     url?: string;
@@ -1334,6 +1340,7 @@ type AssistantInteraction = {
         answer: string;
         sources?: AssistantAnswerSource[];
     };
+    evaluationId: string;
 };
 type State$2 = {
     cues: Cue[];
@@ -2066,6 +2073,7 @@ declare class DeepdeskSDK {
     private broadcastEvents;
     private eventListeners;
     private unmountHandlers;
+    private disposeHandlers;
     private inlineSuggestions;
     private aboveSuggestions;
     private floatingMenu;
@@ -3133,6 +3141,7 @@ declare class DeepdeskSDK {
     setPlatformVariables(mapping: VariableMapping): void;
     /**
      * Registers a callback to be called when conversation is loaded.
+     * Convenient wrapper around `subscribe`.
      *
      * This method allows you to register a callback function that will be executed
      * when a conversation is successfully loaded. The callback is called after
@@ -3141,6 +3150,8 @@ declare class DeepdeskSDK {
      * If a conversation is already loaded when this method is called, the callback
      * will be executed immediately.
      *
+     * If the conversation changes, the callback will be called again.
+     *
      * @param callback - Function to call when conversation loads
      *
      * @example
@@ -3151,7 +3162,7 @@ declare class DeepdeskSDK {
      * });
      * ```
      */
-    whenConversationLoaded(callback: () => void): void;
+    whenConversationLoaded(callback: () => void): Unsubscribe;
     private overlayContainerFactory;
     private createInlineContainer;
     private createContainer;
@@ -3236,15 +3247,17 @@ declare class DeepdeskSDK {
      */
     subscribe<T>(selector: (state: RootState) => T, callback: (value: T) => void): Unsubscribe;
     /**
-     * Unmounts the SDK and cleans up all resources.
+     * Unmounts the SDK and cleans up all resources related to the mount() method.
      *
      * This method removes all UI components, event listeners, and cleans up
-     * internal resources. It should be called when you're done using the SDK
-     * or when you need to remount it on a different element.
+     * internal resources.
      *
      * After calling this method, the SDK instance can be reused by calling
      * `mount()` again on a new input element.
      *
+     * **Important:** This method does not clean up all DeepdeskSDK resources.
+     * Use `dispose()` to clean up all resources instead.
+     *
      * @example
      * ```typescript
      * // Unmount when switching conversations
@@ -3252,6 +3265,19 @@ declare class DeepdeskSDK {
      * ```
      */
     unmount(): void;
+    /**
+     * Disposes of the DeepdeskSDK instance.
+     *
+     * This method removes all UI components, event listeners, and cleans up
+     * internal resources. It should be called when you're done using the SDK.
+     *
+     * @example
+     * ```typescript
+     * // Dispose of DeepdeskSDK instance after conversation is unloaded
+     * sdk.dispose();
+     * ```
+     */
+    dispose(): void;
     private renderSuggestions;
     private renderInlineSuggestions;
     private renderAboveSuggestions;