@deepdesk/deepdesk-sdk 18.2.1-beta.9 → 19.0.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -409,15 +409,13 @@ declare enum FetchState {
409
409
  type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
410
410
  isLoading?: boolean;
411
411
  editable?: boolean;
412
- specialType?: 'summary';
413
412
  evaluationId: string;
414
413
  };
415
414
 
416
- type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
415
+ type EvaluationOutput = CamelCaseKeys<Server.EvaluationOutput>;
417
416
  type ArrayItemType<T> = T extends Array<infer I> ? I : never;
418
- type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
417
+ type Cue = ArrayItemType<EvaluationOutput> & {
419
418
  isLoading?: boolean;
420
- specialType?: 'summary';
421
419
  evaluationId: string;
422
420
  };
423
421
  type AssistantAnswerSource = {
@@ -449,9 +447,7 @@ interface EvaluateInput {
449
447
  transcript?: TranscriptOption;
450
448
  includeMetadata?: boolean;
451
449
  skipState?: boolean;
452
- expectFormat: Server.ResponseFormat;
453
450
  }
454
- type SummaryInput = Omit<EvaluateInput, 'expectFormat'>;
455
451
 
456
452
  type Fetch = typeof window.fetch;
457
453
  type HTTPClientOptions = {
@@ -676,7 +672,6 @@ declare namespace Server {
676
672
  event: string;
677
673
  value?: string;
678
674
  }
679
- type ResponseFormat = 'text' | 'json-object' | 'json-schema:cues' | 'json-schema:knowledge-assist';
680
675
  interface LegacyCue {
681
676
  text: string;
682
677
  title: string;
@@ -690,24 +685,22 @@ declare namespace Server {
690
685
  MAX_RECURSION_LEVEL = "max_recursion_level",
691
686
  NO_ACCESS_TO_ASSISTANT = "no_access_to_assistant"
692
687
  }
693
- type EvaluationResponse<Output extends ResponseFormat> = {
688
+ type EvaluationResponse = {
694
689
  evaluation_id: string;
695
690
  evaluation_status: EvaluationStatus;
696
- output: EvaluationOutput<Output>;
691
+ output: EvaluationOutput;
697
692
  };
698
- type EvaluationOutput<T extends ResponseFormat> = T extends 'text' ? string : T extends 'json-object' ? unknown : T extends 'json-schema:cues' ? Array<{
693
+ type EvaluationOutput = Array<{
699
694
  code: string;
700
695
  name: string;
701
696
  response: string;
702
697
  editable?: boolean;
703
698
  call_to_action?: CallToAction;
704
- }> : T extends 'json-schema:knowledge-assist' ? {
705
- response: string;
706
699
  sources?: {
707
700
  name: string;
708
701
  url: string;
709
702
  }[];
710
- } : never;
703
+ }>;
711
704
  /**
712
705
  * Handling time event data
713
706
  */
@@ -1130,10 +1123,6 @@ declare class DeepdeskAPI {
1130
1123
  * Search
1131
1124
  */
1132
1125
  search(params: SearchOptions): Promise<CamelCaseKeys<Server.SearchResultsData>>;
1133
- knowledgeAssist(request: CamelCaseKeys<Server.KnowledgeRequest>, chatHistory: Server.KnowledgeResponse[], assistantCode: string, meta?: {
1134
- agentId?: string;
1135
- conversationId?: string;
1136
- }): Promise<CamelCaseKeys<Server.KnowledgeResponse['answer']>>;
1137
1126
  requestLoginByEmail(email: string): Promise<{
1138
1127
  code: string;
1139
1128
  message: string;
@@ -1143,8 +1132,7 @@ declare class DeepdeskAPI {
1143
1132
  verifyLoginToken(token: string): Promise<{
1144
1133
  isLoggedIn: boolean;
1145
1134
  }>;
1146
- evaluateAssistant<TOutput extends Server.ResponseFormat = 'text', TInput = Record<string, unknown>>(assistantCode: string, options?: {
1147
- expectFormat: TOutput;
1135
+ evaluateAssistant<TInput = Record<string, unknown>>(assistantCode: string, options?: {
1148
1136
  threadId?: number;
1149
1137
  input: TInput;
1150
1138
  transcript?: Array<{
@@ -1152,7 +1140,7 @@ declare class DeepdeskAPI {
1152
1140
  text: string;
1153
1141
  }>;
1154
1142
  externalConversationId?: string;
1155
- }): Promise<CamelCaseKeys<Server.EvaluationResponse<TOutput>>>;
1143
+ }): Promise<CamelCaseKeys<Server.EvaluationResponse>>;
1156
1144
  createAssistantThread(init: {
1157
1145
  assistantCode: string;
1158
1146
  }): Promise<{
@@ -1335,6 +1323,7 @@ interface State$2 {
1335
1323
  loginFetchState: FetchState;
1336
1324
  verifyFetchState: FetchState;
1337
1325
  showLoginOverlay: boolean;
1326
+ loginError: string | null;
1338
1327
  }
1339
1328
 
1340
1329
  type State$1 = {
@@ -1363,6 +1352,7 @@ declare const reducers: redux.Reducer<{
1363
1352
  customData?: CustomData;
1364
1353
  platformVariables?: VariableMapping;
1365
1354
  fetchState: FetchState;
1355
+ showNicknameDialog: boolean;
1366
1356
  };
1367
1357
  input: State$7;
1368
1358
  settings: {
@@ -1387,6 +1377,7 @@ declare const reducers: redux.Reducer<{
1387
1377
  searchTriggerKey: string;
1388
1378
  visible: boolean;
1389
1379
  insertLink: boolean;
1380
+ addToPersonalCollection: boolean;
1390
1381
  inlineSuggestions: boolean;
1391
1382
  suggestionsPlacement: "inline" | "above" | "below";
1392
1383
  floatingMenu: boolean;
@@ -1397,6 +1388,7 @@ declare const reducers: redux.Reducer<{
1397
1388
  enableSuggestionFeedback: boolean;
1398
1389
  enableFeedbackForm: boolean;
1399
1390
  hasKeyboardInput: boolean;
1391
+ truncateAssistantSuggestion: boolean;
1400
1392
  };
1401
1393
  profile: State$8;
1402
1394
  search: State$b;
@@ -1424,6 +1416,7 @@ declare const reducers: redux.Reducer<{
1424
1416
  customData?: CustomData;
1425
1417
  platformVariables?: VariableMapping;
1426
1418
  fetchState: FetchState;
1419
+ showNicknameDialog: boolean;
1427
1420
  } | undefined;
1428
1421
  input: State$7 | undefined;
1429
1422
  settings: {
@@ -1448,6 +1441,7 @@ declare const reducers: redux.Reducer<{
1448
1441
  searchTriggerKey: string;
1449
1442
  visible: boolean;
1450
1443
  insertLink: boolean;
1444
+ addToPersonalCollection: boolean;
1451
1445
  inlineSuggestions: boolean;
1452
1446
  suggestionsPlacement: "inline" | "above" | "below";
1453
1447
  floatingMenu: boolean;
@@ -1458,6 +1452,7 @@ declare const reducers: redux.Reducer<{
1458
1452
  enableSuggestionFeedback: boolean;
1459
1453
  enableFeedbackForm: boolean;
1460
1454
  hasKeyboardInput: boolean;
1455
+ truncateAssistantSuggestion: boolean;
1461
1456
  } | undefined;
1462
1457
  profile: State$8 | undefined;
1463
1458
  search: State$b | undefined;
@@ -1486,6 +1481,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit.EnhancedStor
1486
1481
  customData?: CustomData;
1487
1482
  platformVariables?: VariableMapping;
1488
1483
  fetchState: FetchState;
1484
+ showNicknameDialog: boolean;
1489
1485
  };
1490
1486
  input: State$7;
1491
1487
  settings: {
@@ -1510,6 +1506,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit.EnhancedStor
1510
1506
  searchTriggerKey: string;
1511
1507
  visible: boolean;
1512
1508
  insertLink: boolean;
1509
+ addToPersonalCollection: boolean;
1513
1510
  inlineSuggestions: boolean;
1514
1511
  suggestionsPlacement: "inline" | "above" | "below";
1515
1512
  floatingMenu: boolean;
@@ -1520,6 +1517,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit.EnhancedStor
1520
1517
  enableSuggestionFeedback: boolean;
1521
1518
  enableFeedbackForm: boolean;
1522
1519
  hasKeyboardInput: boolean;
1520
+ truncateAssistantSuggestion: boolean;
1523
1521
  };
1524
1522
  profile: State$8;
1525
1523
  search: State$b;
@@ -1733,6 +1731,9 @@ declare const styles$5: {
1733
1731
  readonly "hintsHidden": string;
1734
1732
  readonly "isCollapsed": string;
1735
1733
  readonly "isInline": string;
1734
+ readonly "loginError": string;
1735
+ readonly "loginErrorDismiss": string;
1736
+ readonly "loginErrorMessage": string;
1736
1737
  readonly "root": string;
1737
1738
  readonly "toggleButton": string;
1738
1739
  readonly "toggleButtonWrapper": string;
@@ -1772,10 +1773,13 @@ type TabCompletionStyles = typeof styles$4;
1772
1773
 
1773
1774
  declare const styles$3: {
1774
1775
  readonly "actions": string;
1776
+ readonly "assistantBadge": string;
1777
+ readonly "assistantContainer": string;
1775
1778
  readonly "badge": string;
1776
1779
  readonly "closeIcon": string;
1777
1780
  readonly "closeIconContainer": string;
1778
1781
  readonly "formattedText": string;
1782
+ readonly "formattedTextTruncated": string;
1779
1783
  readonly "root": string;
1780
1784
  };
1781
1785
 
@@ -1894,6 +1898,7 @@ type State = {
1894
1898
  searchTriggerKey: string;
1895
1899
  visible: boolean;
1896
1900
  insertLink: boolean;
1901
+ addToPersonalCollection: boolean;
1897
1902
  inlineSuggestions: boolean;
1898
1903
  suggestionsPlacement: 'inline' | 'above' | 'below';
1899
1904
  floatingMenu: boolean;
@@ -1904,6 +1909,7 @@ type State = {
1904
1909
  enableSuggestionFeedback: boolean;
1905
1910
  enableFeedbackForm: boolean;
1906
1911
  hasKeyboardInput: boolean;
1912
+ truncateAssistantSuggestion: boolean;
1907
1913
  };
1908
1914
  type Settings = State;
1909
1915
  declare const set: _reduxjs_toolkit.ActionCreatorWithPayload<Partial<State>, "settings/set">;
@@ -1963,10 +1969,6 @@ interface SDKEventMap {
1963
1969
  selectionAfter: SelectionRange;
1964
1970
  };
1965
1971
  cues: LegacyCue[];
1966
- replace: {
1967
- text: string;
1968
- replace: SelectionRange;
1969
- };
1970
1972
  'select-image': {
1971
1973
  suggestion: TextSuggestion;
1972
1974
  };
@@ -2022,7 +2024,6 @@ interface WidgetOptions {
2022
2024
  }
2023
2025
  interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
2024
2026
  customStyles?: WidgetCustomStyles;
2025
- isLegacyKnowledgeAssist?: boolean;
2026
2027
  title?: string;
2027
2028
  }
2028
2029
  declare class DeepdeskSDK {
@@ -2041,6 +2042,8 @@ declare class DeepdeskSDK {
2041
2042
  private floatingMenu;
2042
2043
  private widgetElement;
2043
2044
  private widgetRoot;
2045
+ private nicknameDialogUnsubscribe;
2046
+ private nicknameDialogFailed;
2044
2047
  private dynamicThunkObject;
2045
2048
  private queues;
2046
2049
  isMounted: boolean;
@@ -2095,6 +2098,7 @@ declare class DeepdeskSDK {
2095
2098
  customData?: CustomData;
2096
2099
  platformVariables?: VariableMapping;
2097
2100
  fetchState: FetchState;
2101
+ showNicknameDialog: boolean;
2098
2102
  };
2099
2103
  input: State$7;
2100
2104
  settings: {
@@ -2119,6 +2123,7 @@ declare class DeepdeskSDK {
2119
2123
  searchTriggerKey: string;
2120
2124
  visible: boolean;
2121
2125
  insertLink: boolean;
2126
+ addToPersonalCollection: boolean;
2122
2127
  inlineSuggestions: boolean;
2123
2128
  suggestionsPlacement: "inline" | "above" | "below";
2124
2129
  floatingMenu: boolean;
@@ -2129,6 +2134,7 @@ declare class DeepdeskSDK {
2129
2134
  enableSuggestionFeedback: boolean;
2130
2135
  enableFeedbackForm: boolean;
2131
2136
  hasKeyboardInput: boolean;
2137
+ truncateAssistantSuggestion: boolean;
2132
2138
  };
2133
2139
  profile: State$8;
2134
2140
  search: State$b;
@@ -2164,6 +2170,7 @@ declare class DeepdeskSDK {
2164
2170
  searchTriggerKey: string;
2165
2171
  visible: boolean;
2166
2172
  insertLink: boolean;
2173
+ addToPersonalCollection: boolean;
2167
2174
  inlineSuggestions: boolean;
2168
2175
  suggestionsPlacement: "inline" | "above" | "below";
2169
2176
  floatingMenu: boolean;
@@ -2174,6 +2181,7 @@ declare class DeepdeskSDK {
2174
2181
  enableSuggestionFeedback: boolean;
2175
2182
  enableFeedbackForm: boolean;
2176
2183
  hasKeyboardInput: boolean;
2184
+ truncateAssistantSuggestion: boolean;
2177
2185
  };
2178
2186
  get selectedTextSuggestion(): TextSuggestion;
2179
2187
  /**
@@ -2754,7 +2762,6 @@ declare class DeepdeskSDK {
2754
2762
  *
2755
2763
  * @param assistantCode - The assistant code to evaluate
2756
2764
  * @param options - Evaluation options
2757
- * @param options.expectFormat - Expected response format ('json-schema:cues', 'json-schema:knowledge-assist', 'text', 'json-object')
2758
2765
  * @param options.input - Additional input data for the assistant
2759
2766
  * @param options.transcript - Transcript option ('in-memory-transcript' or custom transcript)
2760
2767
  * @param options.includeMetadata - Whether to include metadata in the response
@@ -2765,7 +2772,6 @@ declare class DeepdeskSDK {
2765
2772
  * ```typescript
2766
2773
  * // Evaluate assistant with cues format
2767
2774
  * const result = await sdk.evaluateAssistant('assistant-code-123', {
2768
- * expectFormat: 'json-schema:cues',
2769
2775
  * input: {
2770
2776
  * customerType: 'premium',
2771
2777
  * issueType: 'technical'
@@ -2774,7 +2780,6 @@ declare class DeepdeskSDK {
2774
2780
  *
2775
2781
  * // Evaluate with custom transcript
2776
2782
  * const result = await sdk.evaluateAssistant('assistant-code-456', {
2777
- * expectFormat: 'text',
2778
2783
  * transcript: [
2779
2784
  * { source: 'visitor', text: 'I have a problem with my order' },
2780
2785
  * { source: 'agent', text: 'I can help you with that' }
@@ -2788,13 +2793,12 @@ declare class DeepdeskSDK {
2788
2793
  * });
2789
2794
  * ```
2790
2795
  */
2791
- evaluateAssistant<T extends Server.ResponseFormat = 'json-schema:cues'>(assistantCode: string, options?: {
2792
- expectFormat?: T;
2796
+ evaluateAssistant(assistantCode: string, options?: {
2793
2797
  input?: Record<string, any>;
2794
2798
  transcript?: TranscriptOption;
2795
2799
  includeMetadata?: boolean;
2796
2800
  showCuesInWidget?: boolean;
2797
- }): Promise<EvaluationOutput<T> | string>;
2801
+ }): Promise<EvaluationOutput | string>;
2798
2802
  /**
2799
2803
  * Evaluates conversation lifecycle assistants.
2800
2804
  *
@@ -2841,52 +2845,6 @@ declare class DeepdeskSDK {
2841
2845
  includeMetadata?: boolean;
2842
2846
  showCuesInWidget?: boolean;
2843
2847
  }): Promise<void>;
2844
- /**
2845
- * @deprecated Specific 'Summarizer' assistants are deprecated.
2846
- *
2847
- * Generates a summary of the current conversation.
2848
- *
2849
- * This method uses the summarizer assistant configured in the profile to
2850
- * generate a concise summary of the current conversation. It assumes that
2851
- * `setConversationQuery()` has been called before this method and will
2852
- * throw an error if this is not the case.
2853
- *
2854
- * @param args - Summary generation options
2855
- * @param args.includeMetadata - Whether to include metadata in the summary
2856
- * @param args.transcript - Custom transcript to use (optional)
2857
- * @returns Promise that resolves to the summary text or null if no summarizer is configured
2858
- *
2859
- * @example
2860
- * ```typescript
2861
- * // Set up conversation query first
2862
- * sdk.setConversationQuery(async () => {
2863
- * return [
2864
- * { source: 'visitor', text: 'I have a problem with my order' },
2865
- * { source: 'agent', text: 'I can help you with that' },
2866
- * { source: 'visitor', text: 'My order number is 12345' }
2867
- * ];
2868
- * });
2869
- *
2870
- * // Generate summary
2871
- * const summary = await sdk.getSummary();
2872
- * console.log('Conversation summary:', summary);
2873
- *
2874
- * // Generate summary with metadata
2875
- * const summaryWithMetadata = await sdk.getSummary({
2876
- * includeMetadata: true
2877
- * });
2878
- *
2879
- * // Generate summary with custom transcript
2880
- * const customSummary = await sdk.getSummary({
2881
- * transcript: [
2882
- * { source: 'visitor', text: 'Custom conversation data' },
2883
- * { source: 'agent', text: 'Agent response' }
2884
- * ]
2885
- * });
2886
- * ```
2887
- *
2888
- */
2889
- getSummary(args?: Omit<SummaryInput, 'assistantCode'>): Promise<string | null>;
2890
2848
  private handleKeyDown;
2891
2849
  private handleAfterSendMessage;
2892
2850
  /**
@@ -3061,9 +3019,6 @@ declare class DeepdeskSDK {
3061
3019
  * text: msg.content
3062
3020
  * }));
3063
3021
  * });
3064
- *
3065
- * // Now you can use features that require setConversationQuery to be set
3066
- * const summary = await sdk.getSummary();
3067
3022
  * ```
3068
3023
  */
3069
3024
  setConversationQuery(fetchFn: () => Promise<Array<{
@@ -3180,6 +3135,7 @@ declare class DeepdeskSDK {
3180
3135
  * @throws {Error} If the input element is not a supported type (textarea or contentEditable div)
3181
3136
  */
3182
3137
  mount(inputElement: HTMLElement, options?: MountOptions): void;
3138
+ private promptForNickname;
3183
3139
  /**
3184
3140
  * Subscribes to internal state changes.
3185
3141
  *
@@ -3331,7 +3287,6 @@ declare class DeepdeskSDK {
3331
3287
  * @param options.customStyles - Custom styling for the widget
3332
3288
  * @param options.initialQuestion - Initial question to display
3333
3289
  * @param options.emptyState - Custom empty state configuration
3334
- * @param options.isLegacyKnowledgeAssist - Whether to use legacy knowledge assistant (default: false)
3335
3290
  * @param options.title - Custom title for the widget
3336
3291
  * @returns Object with unmount function to clean up the widget
3337
3292
  *