@deepdesk/deepdesk-sdk 14.3.1-beta.9 → 15.0.0

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import React, { FC, HTMLAttributes, ForwardRefExoticComponent, RefAttributes, ReactNode, SyntheticEvent } from 'react';
 import * as redux from 'redux';
+import { Unsubscribe } from 'redux';
 import * as _reduxjs_toolkit_dist_configureStore from '@reduxjs/toolkit/dist/configureStore';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
 import { Middleware } from '@reduxjs/toolkit';
@@ -287,6 +288,7 @@ declare abstract class InputMediator<HTMLElementType extends HTMLElement> {
     focus(): void;
     emit<K extends keyof InputEventMap>(type: K, ...args: Parameters<InputHandler<K>>): void;
     on<K extends keyof InputEventMap>(type: K, handler: InputHandler<K>): void;
+    off<K extends keyof InputEventMap>(type: K, handler: InputHandler<K>): void;
     activate(): void;
     deactivate(): void;
     dispose(): void;
@@ -924,6 +926,15 @@ type SendEventV2ArgumentMap = {
         question: string;
         sourceViewed: string;
     }>;
+    'summary feedback': EventV2<{
+        summary: string;
+        rating: 'up' | 'down';
+    }>;
+    'summary copied to clipboard': EventV2<{
+        originalText: string;
+        finalText: string;
+        assistant: string;
+    }>;
 };
 /**
  * Request retry options
@@ -1284,12 +1295,14 @@ type State$d = {
 
 type LegacyCue$1 = CamelCaseKeys<Server.LegacyCue> & {
     isLoading?: boolean;
+    specialType?: 'summary';
 };
 
 type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
 type ArrayItemType<T> = T extends Array<infer I> ? I : never;
 type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
     isLoading?: boolean;
+    specialType?: 'summary';
 };
 type AssistantAnswerSource = {
     url?: string;
@@ -1394,6 +1407,8 @@ declare const reducers: redux.Reducer<redux.CombinedState<{
         insertLink: boolean;
         inlineSuggestions: boolean;
         floatingMenu: boolean;
+        detectSubmit: boolean;
+        automaticHandlingTime: boolean;
         adminUrl?: string | undefined;
         productName: string;
         enableSuggestionFeedback: boolean;
@@ -1455,6 +1470,8 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         insertLink: boolean;
         inlineSuggestions: boolean;
         floatingMenu: boolean;
+        detectSubmit: boolean;
+        automaticHandlingTime: boolean;
         adminUrl?: string | undefined;
         productName: string;
         enableSuggestionFeedback: boolean;
@@ -1515,6 +1532,8 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         insertLink: boolean;
         inlineSuggestions: boolean;
         floatingMenu: boolean;
+        detectSubmit: boolean;
+        automaticHandlingTime: boolean;
         adminUrl?: string | undefined;
         productName: string;
         enableSuggestionFeedback: boolean;
@@ -1919,12 +1938,15 @@ type State = {
     insertLink: boolean;
     inlineSuggestions: boolean;
     floatingMenu: boolean;
+    detectSubmit: boolean;
+    automaticHandlingTime: boolean;
     adminUrl?: string;
     productName: string;
     enableSuggestionFeedback: boolean;
     enableFeedbackForm: boolean;
     hasKeyboardInput: boolean;
 };
+type Settings = State;
 declare const set: _reduxjs_toolkit.ActionCreatorWithPayload<Partial<State>, "settings/set">;
 
 declare global {
@@ -1977,35 +1999,23 @@ interface SDKEventMap {
     showSearchOverlay: boolean;
 }
 type SDKHandler<K extends keyof SDKEventMap> = (eventPayload: SDKEventMap[K]) => void;
-interface MountOptions {
+interface RenderOptions {
     customStyles?: InputOverlayCustomStyles & {
         rootNode?: string;
         suggestionsRootNode?: string;
         portalRootNode?: string;
-        floatingMenuRootNode?: string;
+        floatingMenuParent?: string;
     };
     closestScrollSelector?: string;
-    automaticHandlingTime?: boolean;
-    showStyleSuggestions?: boolean;
-    showTabCompletion?: boolean;
-    showTextSuggestions?: boolean;
-    showMidSentenceSuggestions?: boolean;
-    showSuggestionsBeforePattern?: string | false;
-    showSuggestionsAfterPattern?: string | false;
-    textSuggestionsCount?: number;
-    detectSubmit?: boolean;
-    insertLink?: boolean;
-    isEmbedded?: boolean;
+    floatingMenuParent?: HTMLElement;
     /**
      * By default append overlay to target.parentElement
      * Optionally append to different HTMLElement, for example `document.body`
      */
     appendOverlayTo?: HTMLElement;
     inputMediator?: InputMediator<HTMLElement>;
-    inlineSuggestions?: boolean;
-    floatingMenu?: boolean | {
-        appendOverlayTo?: HTMLElement;
-    };
+}
+interface MountOptions extends Partial<Settings>, RenderOptions {
 }
 interface WidgetOptions {
     customStyles?: WidgetCustomStyles;
@@ -2021,6 +2031,9 @@ declare class DeepdeskSDK {
     private broadcastEvents;
     private eventListeners;
     private unmountHandlers;
+    private inlineSuggestions;
+    private aboveSuggestions;
+    private floatingMenu;
     private widgetRoot;
     private dynamicThunkObject;
     isMounted: boolean;
@@ -2070,6 +2083,8 @@ declare class DeepdeskSDK {
             insertLink: boolean;
             inlineSuggestions: boolean;
             floatingMenu: boolean;
+            detectSubmit: boolean;
+            automaticHandlingTime: boolean;
             adminUrl?: string | undefined;
             productName: string;
             enableSuggestionFeedback: boolean;
@@ -2113,6 +2128,8 @@ declare class DeepdeskSDK {
         insertLink: boolean;
         inlineSuggestions: boolean;
         floatingMenu: boolean;
+        detectSubmit: boolean;
+        automaticHandlingTime: boolean;
         adminUrl?: string | undefined;
         productName: string;
         enableSuggestionFeedback: boolean;
@@ -2275,7 +2292,13 @@ declare class DeepdeskSDK {
      * @param options - optional mount options
      */
     mount(inputElement: HTMLElement, options?: MountOptions): void;
+    subscribe<T>(selector: (state: RootState) => T, callback: (value: T) => void): Unsubscribe;
     unmount(): void;
+    private renderSuggestions;
+    private renderInlineSuggestions;
+    private renderAboveSuggestions;
+    private renderFloatingMenu;
+    private renderOverlays;
     /**
      * Injects the Deepdesk Widget element into the provided DOM element.
      * @param containerElement - the element to inject the deepdesk element in

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import React, { FC, HTMLAttributes, ForwardRefExoticComponent, RefAttributes, ReactNode, SyntheticEvent } from 'react';
 import * as redux from 'redux';
+import { Unsubscribe } from 'redux';
 import * as _reduxjs_toolkit_dist_configureStore from '@reduxjs/toolkit/dist/configureStore';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
 import { Middleware } from '@reduxjs/toolkit';
@@ -287,6 +288,7 @@ declare abstract class InputMediator<HTMLElementType extends HTMLElement> {
     focus(): void;
     emit<K extends keyof InputEventMap>(type: K, ...args: Parameters<InputHandler<K>>): void;
     on<K extends keyof InputEventMap>(type: K, handler: InputHandler<K>): void;
+    off<K extends keyof InputEventMap>(type: K, handler: InputHandler<K>): void;
     activate(): void;
     deactivate(): void;
     dispose(): void;
@@ -924,6 +926,15 @@ type SendEventV2ArgumentMap = {
         question: string;
         sourceViewed: string;
     }>;
+    'summary feedback': EventV2<{
+        summary: string;
+        rating: 'up' | 'down';
+    }>;
+    'summary copied to clipboard': EventV2<{
+        originalText: string;
+        finalText: string;
+        assistant: string;
+    }>;
 };
 /**
  * Request retry options
@@ -1284,12 +1295,14 @@ type State$d = {
 
 type LegacyCue$1 = CamelCaseKeys<Server.LegacyCue> & {
     isLoading?: boolean;
+    specialType?: 'summary';
 };
 
 type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
 type ArrayItemType<T> = T extends Array<infer I> ? I : never;
 type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
     isLoading?: boolean;
+    specialType?: 'summary';
 };
 type AssistantAnswerSource = {
     url?: string;
@@ -1394,6 +1407,8 @@ declare const reducers: redux.Reducer<redux.CombinedState<{
         insertLink: boolean;
         inlineSuggestions: boolean;
         floatingMenu: boolean;
+        detectSubmit: boolean;
+        automaticHandlingTime: boolean;
         adminUrl?: string | undefined;
         productName: string;
         enableSuggestionFeedback: boolean;
@@ -1455,6 +1470,8 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         insertLink: boolean;
         inlineSuggestions: boolean;
         floatingMenu: boolean;
+        detectSubmit: boolean;
+        automaticHandlingTime: boolean;
         adminUrl?: string | undefined;
         productName: string;
         enableSuggestionFeedback: boolean;
@@ -1515,6 +1532,8 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
         insertLink: boolean;
         inlineSuggestions: boolean;
         floatingMenu: boolean;
+        detectSubmit: boolean;
+        automaticHandlingTime: boolean;
         adminUrl?: string | undefined;
         productName: string;
         enableSuggestionFeedback: boolean;
@@ -1919,12 +1938,15 @@ type State = {
     insertLink: boolean;
     inlineSuggestions: boolean;
     floatingMenu: boolean;
+    detectSubmit: boolean;
+    automaticHandlingTime: boolean;
     adminUrl?: string;
     productName: string;
     enableSuggestionFeedback: boolean;
     enableFeedbackForm: boolean;
     hasKeyboardInput: boolean;
 };
+type Settings = State;
 declare const set: _reduxjs_toolkit.ActionCreatorWithPayload<Partial<State>, "settings/set">;
 
 declare global {
@@ -1977,35 +1999,23 @@ interface SDKEventMap {
     showSearchOverlay: boolean;
 }
 type SDKHandler<K extends keyof SDKEventMap> = (eventPayload: SDKEventMap[K]) => void;
-interface MountOptions {
+interface RenderOptions {
     customStyles?: InputOverlayCustomStyles & {
         rootNode?: string;
         suggestionsRootNode?: string;
         portalRootNode?: string;
-        floatingMenuRootNode?: string;
+        floatingMenuParent?: string;
     };
     closestScrollSelector?: string;
-    automaticHandlingTime?: boolean;
-    showStyleSuggestions?: boolean;
-    showTabCompletion?: boolean;
-    showTextSuggestions?: boolean;
-    showMidSentenceSuggestions?: boolean;
-    showSuggestionsBeforePattern?: string | false;
-    showSuggestionsAfterPattern?: string | false;
-    textSuggestionsCount?: number;
-    detectSubmit?: boolean;
-    insertLink?: boolean;
-    isEmbedded?: boolean;
+    floatingMenuParent?: HTMLElement;
     /**
      * By default append overlay to target.parentElement
      * Optionally append to different HTMLElement, for example `document.body`
      */
     appendOverlayTo?: HTMLElement;
     inputMediator?: InputMediator<HTMLElement>;
-    inlineSuggestions?: boolean;
-    floatingMenu?: boolean | {
-        appendOverlayTo?: HTMLElement;
-    };
+}
+interface MountOptions extends Partial<Settings>, RenderOptions {
 }
 interface WidgetOptions {
     customStyles?: WidgetCustomStyles;
@@ -2021,6 +2031,9 @@ declare class DeepdeskSDK {
     private broadcastEvents;
     private eventListeners;
     private unmountHandlers;
+    private inlineSuggestions;
+    private aboveSuggestions;
+    private floatingMenu;
     private widgetRoot;
     private dynamicThunkObject;
     isMounted: boolean;
@@ -2070,6 +2083,8 @@ declare class DeepdeskSDK {
             insertLink: boolean;
             inlineSuggestions: boolean;
             floatingMenu: boolean;
+            detectSubmit: boolean;
+            automaticHandlingTime: boolean;
             adminUrl?: string | undefined;
             productName: string;
             enableSuggestionFeedback: boolean;
@@ -2113,6 +2128,8 @@ declare class DeepdeskSDK {
         insertLink: boolean;
         inlineSuggestions: boolean;
         floatingMenu: boolean;
+        detectSubmit: boolean;
+        automaticHandlingTime: boolean;
         adminUrl?: string | undefined;
         productName: string;
         enableSuggestionFeedback: boolean;
@@ -2275,7 +2292,13 @@ declare class DeepdeskSDK {
      * @param options - optional mount options
      */
     mount(inputElement: HTMLElement, options?: MountOptions): void;
+    subscribe<T>(selector: (state: RootState) => T, callback: (value: T) => void): Unsubscribe;
     unmount(): void;
+    private renderSuggestions;
+    private renderInlineSuggestions;
+    private renderAboveSuggestions;
+    private renderFloatingMenu;
+    private renderOverlays;
     /**
      * Injects the Deepdesk Widget element into the provided DOM element.
      * @param containerElement - the element to inject the deepdesk element in