@deepdesk/deepdesk-sdk 10.1.4 → 10.1.6

package/dist/index.d.mts

@@ -176,7 +176,7 @@ declare const ToggleButton: React.FC<Props>;
 declare enum Sources {
     SEARCH = "search",
     TEMPLATE = "template",
-    ELASTIC_SEARCH = "studio-search",
+    ELASTIC_SEARCH = "search-autocomplete",
     GPT = "gpt",
     TRIE = "trie",
     TRIE_WITH_TYPOS = "trie-with-typos",
@@ -185,7 +185,10 @@ declare enum Sources {
     URL_RECOMMENDATION = "url_recommendation",
     LINK_RECOMMENDATION = "link_recommendation",
     PERSONAL_COLLECTION = "personal-collection",
-    PERSONAL_COLLECTION_SEARCH = "personal-collection-search"
+    PERSONAL_COLLECTION_SEARCH = "personal-collection-search",
+    SEARCH_OVERLAY = "search-overlay",
+    SEARCH_PREVIEW = "search-preview",
+    SEARCH_URL = "search-url"
 }
 declare enum InputType {
     TAB = "tab",
@@ -450,6 +453,67 @@ interface StoreConfig {
     middleware?: Middleware[];
     preloadedState?: any;
 }
+declare const reducers: redux.Reducer<redux.CombinedState<{
+    activeSuggestion: State$e;
+    answer: State$c;
+    auth: State$d;
+    autoflows: State$6;
+    conversation: State$b;
+    contentTypes: State$a;
+    customMessages: State$9;
+    exchangeToken: State$8;
+    entities: State$7;
+    handlingTime: State$f;
+    info: {
+        agentInfo?: AgentInfo | undefined;
+        agentSettings: unknown;
+        visitorInfo?: VisitorInfo | undefined;
+        fetchState: FetchState;
+    };
+    input: State$5;
+    overlayInput: State$5;
+    settings: {
+        locale: Locale;
+        deanonymize: boolean;
+        fallbackImage: string | false;
+        isEmbedded: boolean;
+        showAutoflows: number | boolean;
+        showCustomMessages: number | boolean;
+        showImages: boolean;
+        showPersonalCollectionLink: boolean;
+        showSearch: boolean;
+        showImageSearch: boolean;
+        showStyleSuggestions: number | boolean;
+        showMidSentenceSuggestions: boolean;
+        showSuggestionsBeforePattern: string | false;
+        showSuggestionsAfterPattern: string | false;
+        showTabCompletion: boolean;
+        showTextSuggestions: boolean;
+        showEntitiesCommand: boolean;
+        showSummaryCommand: boolean;
+        showKnowledgeSearch: boolean;
+        textSuggestionsCount: number;
+        recommendTextSuggestions: boolean;
+        searchTriggerKey: string;
+        visible: boolean;
+        insertLink: boolean;
+        inlineSuggestions: boolean;
+        adminUrl?: string | undefined;
+        productName: string;
+    };
+    profile: State$4;
+    search: State$3;
+    summary: State$2;
+    styleSuggestions: State$1;
+    ui: {
+        showTabHint: boolean;
+        inputHasFocus: boolean;
+        overlayCollapsed: boolean;
+        openOverlayWhenTyping: boolean;
+        overlayCollapsedUserOverwrite: boolean;
+    };
+    textSuggestions: TextSuggestionState;
+}>, redux.AnyAction>;
 declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configureStore.ToolkitStore<redux.EmptyObject & {
     activeSuggestion: State$e;
     answer: State$c;
@@ -575,6 +639,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
     deepdeskAPI: DeepdeskAPI;
     deepdeskBrokerAPI: DeepdeskBrokerAPI | undefined;
 }>[]>;
+type RootState = ReturnType<typeof reducers>;
 type Store = ReturnType<typeof createStore>;
 
 interface State$d {
@@ -1416,6 +1481,7 @@ interface TextSuggestion extends SuggestionApiMetrics {
     url?: string;
     title?: string;
     sourceLabel?: string;
+    searchTerm?: string;
     type?: string;
     searchKeywords?: string[];
     image?: string;
@@ -1453,6 +1519,7 @@ interface SearchSuggestion extends SuggestionApiMetrics {
     id?: string;
     text: string;
     title?: string;
+    source?: string;
     context?: string;
     image?: string;
     type?: SearchResultType;
@@ -1529,6 +1596,7 @@ type MetricState = {
     numCharsDeleted: number;
     numPaste: number;
     agentStartedTypingTimestamp: number | null;
+    externalTimeTotalSeconds: number | null;
     pastes: any[];
     deletions: any[];
     offeredTextSuggestions: TextSuggestion[];
@@ -1592,6 +1660,18 @@ interface TextSuggestionState {
     [type: string]: SuggestionState;
 }
 
+interface MessagePayload {
+    name: string;
+    type: string;
+    channel: string;
+    payload: unknown;
+}
+interface Channel {
+    onMessage(cb: (event: MessageEvent<MessagePayload>) => void): void;
+    postMessage(message: MessagePayload): void;
+    close(): void;
+}
+
 type State = {
     locale: Locale;
     deanonymize: boolean;
@@ -1637,6 +1717,7 @@ interface SDKOptions {
     token?: string;
     fetch?: typeof window.fetch;
     productName?: string;
+    createCustomChannel?: (name: string) => Channel;
 }
 interface SDKEventMap {
     'select-suggestion': {
@@ -1710,7 +1791,7 @@ declare class DeepdeskSDK {
     instanceId: number;
     private shouldRender;
     store: Store;
-    constructor({ deepdeskUrl, brokerUrl, version, locale, token, fetch, productName, }: SDKOptions);
+    constructor({ deepdeskUrl, brokerUrl, version, locale, token, fetch, productName, createCustomChannel, }: SDKOptions);
     get state(): redux.EmptyObject & {
         activeSuggestion: State$e;
         answer: State$c;
@@ -2078,4 +2159,4 @@ declare function waitForElementVisibilityChange(element: HTMLElement, callback:
 type CSSModule = Record<string, string>;
 declare function useStyles<TStyles extends CSSModule>(componentName: string, defaultStyles: TStyles): TStyles;
 
-export { AgentInfo, Card, Chip, ContentEditableInput, Conversation, ConversationMessage, DeepdeskAPI, DeepdeskSDK, InputMediator, InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, Logger, MountOptions, PinnedMessage, PlatformConfig, Section, SectionList, SelectionRange, Sources, Suggestion, SuggestionEventMetrics, SuggestionList, SuggestionMetrics, TextAreaInput, TextSuggestion, ToggleButton, UrlSuggestion, VisitorInfo, WidgetCustomStyles, WidgetOptions, attachFile, authenticateWithKey, createOverlayContainer, createRangeFromOffsets, escapeHTML, fetchPlatformConfig, formatTextMarkup, getRangeOffsets, getRangeText, isSupportedInputElement, updateContentEditable, updateTextArea, useStyles, waitForElementVisibilityChange };
+export { AgentInfo, Card, Chip, ContentEditableInput, Conversation, ConversationMessage, DeepdeskAPI, DeepdeskSDK, HTTPClient, InputMediator, InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, Logger, MountOptions, PinnedMessage, PlatformConfig, RootState, Section, SectionList, SelectionRange, Sources, Suggestion, SuggestionEventMetrics, SuggestionList, SuggestionMetrics, TextAreaInput, TextSuggestion, ToggleButton, UrlSuggestion, VisitorInfo, WidgetCustomStyles, WidgetOptions, attachFile, authenticateWithKey, createOverlayContainer, createRangeFromOffsets, escapeHTML, fetchPlatformConfig, formatTextMarkup, getRangeOffsets, getRangeText, isSupportedInputElement, updateContentEditable, updateTextArea, useStyles, waitForElementVisibilityChange };

package/dist/index.d.ts

@@ -176,7 +176,7 @@ declare const ToggleButton: React.FC<Props>;
 declare enum Sources {
     SEARCH = "search",
     TEMPLATE = "template",
-    ELASTIC_SEARCH = "studio-search",
+    ELASTIC_SEARCH = "search-autocomplete",
     GPT = "gpt",
     TRIE = "trie",
     TRIE_WITH_TYPOS = "trie-with-typos",
@@ -185,7 +185,10 @@ declare enum Sources {
     URL_RECOMMENDATION = "url_recommendation",
     LINK_RECOMMENDATION = "link_recommendation",
     PERSONAL_COLLECTION = "personal-collection",
-    PERSONAL_COLLECTION_SEARCH = "personal-collection-search"
+    PERSONAL_COLLECTION_SEARCH = "personal-collection-search",
+    SEARCH_OVERLAY = "search-overlay",
+    SEARCH_PREVIEW = "search-preview",
+    SEARCH_URL = "search-url"
 }
 declare enum InputType {
     TAB = "tab",
@@ -450,6 +453,67 @@ interface StoreConfig {
     middleware?: Middleware[];
     preloadedState?: any;
 }
+declare const reducers: redux.Reducer<redux.CombinedState<{
+    activeSuggestion: State$e;
+    answer: State$c;
+    auth: State$d;
+    autoflows: State$6;
+    conversation: State$b;
+    contentTypes: State$a;
+    customMessages: State$9;
+    exchangeToken: State$8;
+    entities: State$7;
+    handlingTime: State$f;
+    info: {
+        agentInfo?: AgentInfo | undefined;
+        agentSettings: unknown;
+        visitorInfo?: VisitorInfo | undefined;
+        fetchState: FetchState;
+    };
+    input: State$5;
+    overlayInput: State$5;
+    settings: {
+        locale: Locale;
+        deanonymize: boolean;
+        fallbackImage: string | false;
+        isEmbedded: boolean;
+        showAutoflows: number | boolean;
+        showCustomMessages: number | boolean;
+        showImages: boolean;
+        showPersonalCollectionLink: boolean;
+        showSearch: boolean;
+        showImageSearch: boolean;
+        showStyleSuggestions: number | boolean;
+        showMidSentenceSuggestions: boolean;
+        showSuggestionsBeforePattern: string | false;
+        showSuggestionsAfterPattern: string | false;
+        showTabCompletion: boolean;
+        showTextSuggestions: boolean;
+        showEntitiesCommand: boolean;
+        showSummaryCommand: boolean;
+        showKnowledgeSearch: boolean;
+        textSuggestionsCount: number;
+        recommendTextSuggestions: boolean;
+        searchTriggerKey: string;
+        visible: boolean;
+        insertLink: boolean;
+        inlineSuggestions: boolean;
+        adminUrl?: string | undefined;
+        productName: string;
+    };
+    profile: State$4;
+    search: State$3;
+    summary: State$2;
+    styleSuggestions: State$1;
+    ui: {
+        showTabHint: boolean;
+        inputHasFocus: boolean;
+        overlayCollapsed: boolean;
+        openOverlayWhenTyping: boolean;
+        overlayCollapsedUserOverwrite: boolean;
+    };
+    textSuggestions: TextSuggestionState;
+}>, redux.AnyAction>;
 declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configureStore.ToolkitStore<redux.EmptyObject & {
     activeSuggestion: State$e;
     answer: State$c;
@@ -575,6 +639,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit_dist_configu
     deepdeskAPI: DeepdeskAPI;
     deepdeskBrokerAPI: DeepdeskBrokerAPI | undefined;
 }>[]>;
+type RootState = ReturnType<typeof reducers>;
 type Store = ReturnType<typeof createStore>;
 
 interface State$d {
@@ -1416,6 +1481,7 @@ interface TextSuggestion extends SuggestionApiMetrics {
     url?: string;
     title?: string;
     sourceLabel?: string;
+    searchTerm?: string;
     type?: string;
     searchKeywords?: string[];
     image?: string;
@@ -1453,6 +1519,7 @@ interface SearchSuggestion extends SuggestionApiMetrics {
     id?: string;
     text: string;
     title?: string;
+    source?: string;
     context?: string;
     image?: string;
     type?: SearchResultType;
@@ -1529,6 +1596,7 @@ type MetricState = {
     numCharsDeleted: number;
     numPaste: number;
     agentStartedTypingTimestamp: number | null;
+    externalTimeTotalSeconds: number | null;
     pastes: any[];
     deletions: any[];
     offeredTextSuggestions: TextSuggestion[];
@@ -1592,6 +1660,18 @@ interface TextSuggestionState {
     [type: string]: SuggestionState;
 }
 
+interface MessagePayload {
+    name: string;
+    type: string;
+    channel: string;
+    payload: unknown;
+}
+interface Channel {
+    onMessage(cb: (event: MessageEvent<MessagePayload>) => void): void;
+    postMessage(message: MessagePayload): void;
+    close(): void;
+}
+
 type State = {
     locale: Locale;
     deanonymize: boolean;
@@ -1637,6 +1717,7 @@ interface SDKOptions {
     token?: string;
     fetch?: typeof window.fetch;
     productName?: string;
+    createCustomChannel?: (name: string) => Channel;
 }
 interface SDKEventMap {
     'select-suggestion': {
@@ -1710,7 +1791,7 @@ declare class DeepdeskSDK {
     instanceId: number;
     private shouldRender;
     store: Store;
-    constructor({ deepdeskUrl, brokerUrl, version, locale, token, fetch, productName, }: SDKOptions);
+    constructor({ deepdeskUrl, brokerUrl, version, locale, token, fetch, productName, createCustomChannel, }: SDKOptions);
     get state(): redux.EmptyObject & {
         activeSuggestion: State$e;
         answer: State$c;
@@ -2078,4 +2159,4 @@ declare function waitForElementVisibilityChange(element: HTMLElement, callback:
 type CSSModule = Record<string, string>;
 declare function useStyles<TStyles extends CSSModule>(componentName: string, defaultStyles: TStyles): TStyles;
 
-export { AgentInfo, Card, Chip, ContentEditableInput, Conversation, ConversationMessage, DeepdeskAPI, DeepdeskSDK, InputMediator, InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, Logger, MountOptions, PinnedMessage, PlatformConfig, Section, SectionList, SelectionRange, Sources, Suggestion, SuggestionEventMetrics, SuggestionList, SuggestionMetrics, TextAreaInput, TextSuggestion, ToggleButton, UrlSuggestion, VisitorInfo, WidgetCustomStyles, WidgetOptions, attachFile, authenticateWithKey, createOverlayContainer, createRangeFromOffsets, escapeHTML, fetchPlatformConfig, formatTextMarkup, getRangeOffsets, getRangeText, isSupportedInputElement, updateContentEditable, updateTextArea, useStyles, waitForElementVisibilityChange };
+export { AgentInfo, Card, Chip, ContentEditableInput, Conversation, ConversationMessage, DeepdeskAPI, DeepdeskSDK, HTTPClient, InputMediator, InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, Logger, MountOptions, PinnedMessage, PlatformConfig, RootState, Section, SectionList, SelectionRange, Sources, Suggestion, SuggestionEventMetrics, SuggestionList, SuggestionMetrics, TextAreaInput, TextSuggestion, ToggleButton, UrlSuggestion, VisitorInfo, WidgetCustomStyles, WidgetOptions, attachFile, authenticateWithKey, createOverlayContainer, createRangeFromOffsets, escapeHTML, fetchPlatformConfig, formatTextMarkup, getRangeOffsets, getRangeText, isSupportedInputElement, updateContentEditable, updateTextArea, useStyles, waitForElementVisibilityChange };