@deepdesk/deepdesk-sdk 18.1.1-beta.0 → 18.1.2-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
@@ -5,7 +5,7 @@ import { Middleware, Tuple } from '@reduxjs/toolkit';
5
5
  import * as redux from 'redux';
6
6
  import { Unsubscribe } from 'redux';
7
7
 
8
- declare const styles$t: {
8
+ declare const styles$s: {
9
9
  readonly "content": string;
10
10
  readonly "contentIsCropped": string;
11
11
  readonly "image": string;
@@ -36,12 +36,12 @@ interface CardComposition {
36
36
  Content: FC<ContentProps>;
37
37
  Title: FC<TitleProps>;
38
38
  }
39
- type CardStyles = typeof styles$t;
39
+ type CardStyles = typeof styles$s;
40
40
  declare const Card: FC<{
41
41
  children: React.ReactNode;
42
42
  }> & CardComposition;
43
43
 
44
- declare const styles$s: {
44
+ declare const styles$r: {
45
45
  readonly "root": string;
46
46
  };
47
47
 
@@ -56,18 +56,18 @@ type Props$6 = HTMLAttributes<HTMLSpanElement> & {
56
56
  className?: string;
57
57
  keyCode: KeyboardHintKey;
58
58
  };
59
- type KeyboardHintStyles = typeof styles$s;
59
+ type KeyboardHintStyles = typeof styles$r;
60
60
  declare const KeyboardHint: React.FC<Props$6>;
61
61
 
62
- declare const styles$r: {
62
+ declare const styles$q: {
63
63
  readonly "root": string;
64
64
  };
65
65
 
66
66
  type Props$5 = HTMLAttributes<HTMLSpanElement>;
67
- type LabelStyles = typeof styles$r;
67
+ type LabelStyles = typeof styles$q;
68
68
  declare const Label: React.FC<Props$5>;
69
69
 
70
- declare const styles$q: {
70
+ declare const styles$p: {
71
71
  readonly "root": string;
72
72
  readonly "subTitleContainer": string;
73
73
  readonly "subtitle": string;
@@ -78,10 +78,10 @@ type Props$4 = HTMLAttributes<HTMLElement> & {
78
78
  type: string;
79
79
  title?: string;
80
80
  };
81
- type SectionStyles = typeof styles$q;
81
+ type SectionStyles = typeof styles$p;
82
82
  declare const Section: React.FC<Props$4>;
83
83
 
84
- declare const styles$p: {
84
+ declare const styles$o: {
85
85
  readonly "root": string;
86
86
  };
87
87
 
@@ -89,10 +89,10 @@ type Props$3 = {
89
89
  className?: string;
90
90
  children?: React.ReactNode;
91
91
  };
92
- type SectionListStyles = typeof styles$p;
92
+ type SectionListStyles = typeof styles$o;
93
93
  declare const SectionList: React.FC<Props$3>;
94
94
 
95
- declare const styles$o: {
95
+ declare const styles$n: {
96
96
  readonly "actionButton": string;
97
97
  readonly "actionButtonIsDisabled": string;
98
98
  readonly "actionButtonIsPrimary": string;
@@ -160,22 +160,22 @@ interface SuggestionComposition {
160
160
  Button: typeof Button;
161
161
  ButtonsContainer: typeof ButtonsContainer;
162
162
  }
163
- type SuggestionStyles = typeof styles$o;
163
+ type SuggestionStyles = typeof styles$n;
164
164
  declare const Suggestion: ForwardRefExoticComponent<Props$2 & RefAttributes<any>> & SuggestionComposition;
165
165
 
166
- declare const styles$n: {
166
+ declare const styles$m: {
167
167
  readonly "isWithDivider": string;
168
168
  readonly "root": string;
169
169
  };
170
170
 
171
- type SuggestionListStyles = typeof styles$n;
171
+ type SuggestionListStyles = typeof styles$m;
172
172
  interface Props$1 {
173
173
  withDivider?: boolean;
174
174
  children: React.ReactNode;
175
175
  }
176
176
  declare const SuggestionList: React.FC<Props$1>;
177
177
 
178
- declare const styles$m: {
178
+ declare const styles$l: {
179
179
  readonly "isCollapsed": string;
180
180
  readonly "root": string;
181
181
  };
@@ -184,7 +184,7 @@ type Props = HTMLAttributes<HTMLButtonElement> & {
184
184
  isCollapsed: boolean;
185
185
  title: string;
186
186
  };
187
- type ToggleButtonStyles = typeof styles$m;
187
+ type ToggleButtonStyles = typeof styles$l;
188
188
  declare const ToggleButton: React.FC<Props>;
189
189
 
190
190
  declare enum Sources {
@@ -403,6 +403,53 @@ declare enum FetchState {
403
403
  ERROR = "error"
404
404
  }
405
405
 
406
+ type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
407
+ isLoading?: boolean;
408
+ editable?: boolean;
409
+ specialType?: 'summary';
410
+ evaluationId: string;
411
+ };
412
+
413
+ type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
414
+ type ArrayItemType<T> = T extends Array<infer I> ? I : never;
415
+ type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
416
+ isLoading?: boolean;
417
+ specialType?: 'summary';
418
+ evaluationId: string;
419
+ };
420
+ type AssistantAnswerSource = {
421
+ url?: string;
422
+ name: string;
423
+ };
424
+ type AssistantInteraction = {
425
+ question: string;
426
+ answer: {
427
+ answer: string;
428
+ sources?: AssistantAnswerSource[];
429
+ };
430
+ evaluationId: string;
431
+ };
432
+ type State$a = {
433
+ cues: Cue[];
434
+ threads: Record<number, AssistantInteraction[]>;
435
+ pending: string[];
436
+ };
437
+ type Transcript = Array<{
438
+ source: string;
439
+ text: string;
440
+ }>;
441
+ type TranscriptOption = 'in-memory-transcript' | Transcript;
442
+ interface EvaluateInput {
443
+ assistantCode: string;
444
+ threadId?: number;
445
+ input?: any;
446
+ transcript?: TranscriptOption;
447
+ includeMetadata?: boolean;
448
+ skipState?: boolean;
449
+ expectFormat: Server.ResponseFormat;
450
+ }
451
+ type SummaryInput = Omit<EvaluateInput, 'assistantCode' | 'expectFormat'>;
452
+
406
453
  type Fetch = typeof window.fetch;
407
454
  type HTTPClientOptions = {
408
455
  fetch?: typeof window.fetch;
@@ -904,8 +951,8 @@ type HandlingTimeEventData = CamelCaseKeys<Server.HandlingTimeEventData>;
904
951
  * Rule event meta data
905
952
  */
906
953
  type RuleEventMeta = {
907
- name: string;
908
- description: string;
954
+ name?: string;
955
+ description?: string;
909
956
  group: string;
910
957
  evaluationId: string;
911
958
  };
@@ -940,6 +987,8 @@ type SendEventArgumentMap = {
940
987
  }>;
941
988
  'Assistant response displayed': Event$1<RuleEventMeta & {
942
989
  cueText: string;
990
+ input?: string;
991
+ sources?: AssistantAnswerSource[];
943
992
  }>;
944
993
  'Assistant response closed': Event$1<RuleEventMeta & {
945
994
  cueText: string;
@@ -961,28 +1010,14 @@ type SendEventArgumentMap = {
961
1010
  eventName: string;
962
1011
  value: string;
963
1012
  }>;
964
- 'knowledge assist feedback': Event$1<{
965
- question: string;
966
- isFollowUpQuestion: boolean;
967
- isAgent: boolean;
968
- answer: Server.KnowledgeResponse['answer'];
969
- }>;
970
- 'knowledge assist question answered': Event$1<{
971
- question: string;
972
- answer: string;
973
- sources: {
974
- url?: string;
975
- name: string;
976
- }[];
977
- isFollowUpQuestion: boolean;
978
- isAutoInitiated: boolean;
979
- }>;
980
- 'knowledge assist source viewed': Event$1<{
981
- question: string;
982
- sourceViewed: string;
1013
+ 'Assistant source clicked': Event$1<{
1014
+ evaluationId: string;
1015
+ source: AssistantAnswerSource;
1016
+ assistantCode: string;
983
1017
  }>;
984
- 'knowledge assist reset': Event$1<{
1018
+ 'Assistant thread reset': Event$1<{
985
1019
  threadId?: number;
1020
+ assistantCode: string;
986
1021
  }>;
987
1022
  'summary feedback': Event$1<{
988
1023
  summary: string;
@@ -1157,12 +1192,12 @@ declare class DeepdeskAPI {
1157
1192
  }
1158
1193
 
1159
1194
  type StyleSuggestion = CamelCaseKeys<Server.StyleSuggestion>;
1160
- interface State$a {
1195
+ interface State$9 {
1161
1196
  list: StyleSuggestion;
1162
1197
  fetchState: FetchState;
1163
1198
  }
1164
1199
 
1165
- type State$9 = {
1200
+ type State$8 = {
1166
1201
  data: Profile | null;
1167
1202
  fetchState: FetchState;
1168
1203
  };
@@ -1280,7 +1315,7 @@ type MetricState = {
1280
1315
  textSuggestions: SuggestionMetrics[];
1281
1316
  cuts: any[];
1282
1317
  };
1283
- type State$8 = {
1318
+ type State$7 = {
1284
1319
  text: string;
1285
1320
  html: string | null;
1286
1321
  selection: SelectionRange;
@@ -1296,81 +1331,34 @@ type State$8 = {
1296
1331
  selectedSuggestionIndex: number;
1297
1332
  };
1298
1333
 
1299
- type State$7 = {
1334
+ type State$6 = {
1300
1335
  startTime: Date | null;
1301
1336
  stopTime: Date | null;
1302
1337
  };
1303
1338
 
1304
- type State$6 = {
1339
+ type State$5 = {
1305
1340
  token: string | null;
1306
1341
  interval: NodeJS.Timer | null;
1307
1342
  };
1308
1343
 
1309
1344
  type ContentType = CamelCaseKeys<Server.ContentType>;
1310
- type State$5 = {
1345
+ type State$4 = {
1311
1346
  data: ContentType[] | null;
1312
1347
  fetchState: FetchState;
1313
1348
  };
1314
1349
 
1315
- interface State$4 {
1350
+ interface State$3 {
1316
1351
  current: Conversation | null;
1317
1352
  isSupported: boolean | null;
1318
1353
  }
1319
1354
 
1320
- interface State$3 {
1355
+ interface State$2 {
1321
1356
  isLoggedIn: boolean | null;
1322
1357
  loginFetchState: FetchState;
1323
1358
  verifyFetchState: FetchState;
1324
1359
  showLoginOverlay: boolean;
1325
1360
  }
1326
1361
 
1327
- type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
1328
- isLoading?: boolean;
1329
- editable?: boolean;
1330
- specialType?: 'summary';
1331
- evaluationId: string;
1332
- };
1333
-
1334
- type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
1335
- type ArrayItemType<T> = T extends Array<infer I> ? I : never;
1336
- type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
1337
- isLoading?: boolean;
1338
- specialType?: 'summary';
1339
- evaluationId: string;
1340
- };
1341
- type AssistantAnswerSource = {
1342
- url?: string;
1343
- name: string;
1344
- };
1345
- type AssistantInteraction = {
1346
- question: string;
1347
- answer: {
1348
- answer: string;
1349
- sources?: AssistantAnswerSource[];
1350
- };
1351
- evaluationId: string;
1352
- };
1353
- type State$2 = {
1354
- cues: Cue[];
1355
- threads: Record<number, AssistantInteraction[]>;
1356
- pending: string[];
1357
- };
1358
- type Transcript = Array<{
1359
- source: string;
1360
- text: string;
1361
- }>;
1362
- type TranscriptOption = 'in-memory-transcript' | Transcript;
1363
- interface EvaluateInput {
1364
- assistantCode: string;
1365
- threadId?: number;
1366
- input?: any;
1367
- transcript?: TranscriptOption;
1368
- includeMetadata?: boolean;
1369
- skipState?: boolean;
1370
- expectFormat: Server.ResponseFormat;
1371
- }
1372
- type SummaryInput = Omit<EvaluateInput, 'assistantCode' | 'expectFormat'>;
1373
-
1374
1362
  type State$1 = {
1375
1363
  data: Entity[] | null;
1376
1364
  fetchState: FetchState;
@@ -1383,13 +1371,13 @@ interface StoreConfig {
1383
1371
  preloadedState?: any;
1384
1372
  }
1385
1373
  declare const reducers: redux.Reducer<{
1386
- assistants: State$2;
1387
- auth: State$3;
1388
- conversation: State$4;
1389
- contentTypes: State$5;
1390
- passwordlessToken: State$6;
1374
+ assistants: State$a;
1375
+ auth: State$2;
1376
+ conversation: State$3;
1377
+ contentTypes: State$4;
1378
+ passwordlessToken: State$5;
1391
1379
  entities: State$1;
1392
- handlingTime: State$7;
1380
+ handlingTime: State$6;
1393
1381
  info: {
1394
1382
  agentInfo?: AgentInfo;
1395
1383
  agentSettings: unknown;
@@ -1398,7 +1386,7 @@ declare const reducers: redux.Reducer<{
1398
1386
  platformVariables?: VariableMapping;
1399
1387
  fetchState: FetchState;
1400
1388
  };
1401
- input: State$8;
1389
+ input: State$7;
1402
1390
  settings: {
1403
1391
  locale: Locale;
1404
1392
  deanonymize: boolean;
@@ -1431,9 +1419,9 @@ declare const reducers: redux.Reducer<{
1431
1419
  enableFeedbackForm: boolean;
1432
1420
  hasKeyboardInput: boolean;
1433
1421
  };
1434
- profile: State$9;
1422
+ profile: State$8;
1435
1423
  search: State$b;
1436
- styleSuggestions: State$a;
1424
+ styleSuggestions: State$9;
1437
1425
  ui: {
1438
1426
  showTabHint: boolean;
1439
1427
  inputHasFocus: boolean;
@@ -1443,13 +1431,13 @@ declare const reducers: redux.Reducer<{
1443
1431
  };
1444
1432
  textSuggestions: TextSuggestionState;
1445
1433
  }, redux.UnknownAction, Partial<{
1446
- assistants: State$2 | undefined;
1447
- auth: State$3 | undefined;
1448
- conversation: State$4 | undefined;
1449
- contentTypes: State$5 | undefined;
1450
- passwordlessToken: State$6 | undefined;
1434
+ assistants: State$a | undefined;
1435
+ auth: State$2 | undefined;
1436
+ conversation: State$3 | undefined;
1437
+ contentTypes: State$4 | undefined;
1438
+ passwordlessToken: State$5 | undefined;
1451
1439
  entities: State$1 | undefined;
1452
- handlingTime: State$7 | undefined;
1440
+ handlingTime: State$6 | undefined;
1453
1441
  info: {
1454
1442
  agentInfo?: AgentInfo;
1455
1443
  agentSettings: unknown;
@@ -1458,7 +1446,7 @@ declare const reducers: redux.Reducer<{
1458
1446
  platformVariables?: VariableMapping;
1459
1447
  fetchState: FetchState;
1460
1448
  } | undefined;
1461
- input: State$8 | undefined;
1449
+ input: State$7 | undefined;
1462
1450
  settings: {
1463
1451
  locale: Locale;
1464
1452
  deanonymize: boolean;
@@ -1491,9 +1479,9 @@ declare const reducers: redux.Reducer<{
1491
1479
  enableFeedbackForm: boolean;
1492
1480
  hasKeyboardInput: boolean;
1493
1481
  } | undefined;
1494
- profile: State$9 | undefined;
1482
+ profile: State$8 | undefined;
1495
1483
  search: State$b | undefined;
1496
- styleSuggestions: State$a | undefined;
1484
+ styleSuggestions: State$9 | undefined;
1497
1485
  ui: {
1498
1486
  showTabHint: boolean;
1499
1487
  inputHasFocus: boolean;
@@ -1504,13 +1492,13 @@ declare const reducers: redux.Reducer<{
1504
1492
  textSuggestions: TextSuggestionState | undefined;
1505
1493
  }>>;
1506
1494
  declare function createStore(config: StoreConfig): _reduxjs_toolkit.EnhancedStore<{
1507
- assistants: State$2;
1508
- auth: State$3;
1509
- conversation: State$4;
1510
- contentTypes: State$5;
1511
- passwordlessToken: State$6;
1495
+ assistants: State$a;
1496
+ auth: State$2;
1497
+ conversation: State$3;
1498
+ contentTypes: State$4;
1499
+ passwordlessToken: State$5;
1512
1500
  entities: State$1;
1513
- handlingTime: State$7;
1501
+ handlingTime: State$6;
1514
1502
  info: {
1515
1503
  agentInfo?: AgentInfo;
1516
1504
  agentSettings: unknown;
@@ -1519,7 +1507,7 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit.EnhancedStor
1519
1507
  platformVariables?: VariableMapping;
1520
1508
  fetchState: FetchState;
1521
1509
  };
1522
- input: State$8;
1510
+ input: State$7;
1523
1511
  settings: {
1524
1512
  locale: Locale;
1525
1513
  deanonymize: boolean;
@@ -1552,9 +1540,9 @@ declare function createStore(config: StoreConfig): _reduxjs_toolkit.EnhancedStor
1552
1540
  enableFeedbackForm: boolean;
1553
1541
  hasKeyboardInput: boolean;
1554
1542
  };
1555
- profile: State$9;
1543
+ profile: State$8;
1556
1544
  search: State$b;
1557
- styleSuggestions: State$a;
1545
+ styleSuggestions: State$9;
1558
1546
  ui: {
1559
1547
  showTabHint: boolean;
1560
1548
  inputHasFocus: boolean;
@@ -1577,7 +1565,7 @@ interface TextSuggestionState {
1577
1565
  [type: string]: SuggestionState;
1578
1566
  }
1579
1567
 
1580
- declare const styles$l: {
1568
+ declare const styles$k: {
1581
1569
  readonly "actionButton": string;
1582
1570
  readonly "actionShortcut": string;
1583
1571
  readonly "actionShortcutFixKerning": string;
@@ -1627,23 +1615,23 @@ declare const styles$l: {
1627
1615
  readonly "truncate": string;
1628
1616
  };
1629
1617
 
1630
- type CommandPaletteStyles = typeof styles$l;
1618
+ type CommandPaletteStyles = typeof styles$k;
1631
1619
 
1632
- declare const styles$k: {
1620
+ declare const styles$j: {
1633
1621
  readonly "content": string;
1634
1622
  readonly "root": string;
1635
1623
  };
1636
1624
 
1637
- type DialogStyles = typeof styles$k;
1625
+ type DialogStyles = typeof styles$j;
1638
1626
 
1639
- declare const styles$j: {
1627
+ declare const styles$i: {
1640
1628
  readonly "empty": string;
1641
1629
  readonly "root": string;
1642
1630
  };
1643
1631
 
1644
- type EntitiesListStyles = typeof styles$j;
1632
+ type EntitiesListStyles = typeof styles$i;
1645
1633
 
1646
- declare const styles$i: {
1634
+ declare const styles$h: {
1647
1635
  readonly "entity": string;
1648
1636
  readonly "entityText": string;
1649
1637
  readonly "icon": string;
@@ -1652,9 +1640,9 @@ declare const styles$i: {
1652
1640
  readonly "root": string;
1653
1641
  };
1654
1642
 
1655
- type EntitiesWidgetListStyles = typeof styles$i;
1643
+ type EntitiesWidgetListStyles = typeof styles$h;
1656
1644
 
1657
- declare const styles$h: {
1645
+ declare const styles$g: {
1658
1646
  readonly "fadedown": string;
1659
1647
  readonly "fadeup": string;
1660
1648
  readonly "selected": string;
@@ -1663,9 +1651,9 @@ declare const styles$h: {
1663
1651
  readonly "thumbsUp": string;
1664
1652
  };
1665
1653
 
1666
- type FeedbackThumbsStyles = typeof styles$h;
1654
+ type FeedbackThumbsStyles = typeof styles$g;
1667
1655
 
1668
- declare const styles$g: {
1656
+ declare const styles$f: {
1669
1657
  readonly "icon": string;
1670
1658
  readonly "isLoggedIn": string;
1671
1659
  readonly "isLoggedOut": string;
@@ -1675,30 +1663,14 @@ declare const styles$g: {
1675
1663
  readonly "text": string;
1676
1664
  };
1677
1665
 
1678
- type FloatingMenuStyles = typeof styles$g;
1679
-
1680
- declare const styles$f: {
1681
- readonly "paper": string;
1682
- readonly "root": string;
1683
- };
1684
-
1685
- type InlineSuggestionsOverlayStyles = typeof styles$f;
1666
+ type FloatingMenuStyles = typeof styles$f;
1686
1667
 
1687
1668
  declare const styles$e: {
1688
- readonly "alignRight": string;
1689
- readonly "answer": string;
1690
- readonly "empty": string;
1691
- readonly "form": string;
1692
- readonly "input": string;
1693
- readonly "listItemFeedback": string;
1694
- readonly "question": string;
1669
+ readonly "paper": string;
1695
1670
  readonly "root": string;
1696
- readonly "status": string;
1697
- readonly "submit": string;
1698
- readonly "title": string;
1699
1671
  };
1700
1672
 
1701
- type KnowledgeSearchStyles = typeof styles$e;
1673
+ type InlineSuggestionsOverlayStyles = typeof styles$e;
1702
1674
 
1703
1675
  declare const styles$d: {
1704
1676
  readonly "content": string;
@@ -1892,7 +1864,6 @@ type InputOverlayCustomStyles = {
1892
1864
  CommandPalette?: Partial<CommandPaletteStyles>;
1893
1865
  EntitiesList?: Partial<EntitiesListStyles>;
1894
1866
  FeedbackThumbs?: Partial<FeedbackThumbsStyles>;
1895
- KnowledgeSearch?: Partial<KnowledgeSearchStyles>;
1896
1867
  Label?: Partial<LabelStyles>;
1897
1868
  Login?: Partial<LoginStyles>;
1898
1869
  LoginTokenDialog?: Partial<LoginTokenDialogStyles>;
@@ -2127,13 +2098,13 @@ declare class DeepdeskSDK {
2127
2098
  */
2128
2099
  constructor({ deepdeskUrl, version, locale, token, fetch, productName, createCustomChannel, websocketClient, }: SDKOptions);
2129
2100
  get state(): {
2130
- assistants: State$2;
2131
- auth: State$3;
2132
- conversation: State$4;
2133
- contentTypes: State$5;
2134
- passwordlessToken: State$6;
2101
+ assistants: State$a;
2102
+ auth: State$2;
2103
+ conversation: State$3;
2104
+ contentTypes: State$4;
2105
+ passwordlessToken: State$5;
2135
2106
  entities: State$1;
2136
- handlingTime: State$7;
2107
+ handlingTime: State$6;
2137
2108
  info: {
2138
2109
  agentInfo?: AgentInfo;
2139
2110
  agentSettings: unknown;
@@ -2142,7 +2113,7 @@ declare class DeepdeskSDK {
2142
2113
  platformVariables?: VariableMapping;
2143
2114
  fetchState: FetchState;
2144
2115
  };
2145
- input: State$8;
2116
+ input: State$7;
2146
2117
  settings: {
2147
2118
  locale: Locale;
2148
2119
  deanonymize: boolean;
@@ -2175,9 +2146,9 @@ declare class DeepdeskSDK {
2175
2146
  enableFeedbackForm: boolean;
2176
2147
  hasKeyboardInput: boolean;
2177
2148
  };
2178
- profile: State$9;
2149
+ profile: State$8;
2179
2150
  search: State$b;
2180
- styleSuggestions: State$a;
2151
+ styleSuggestions: State$9;
2181
2152
  ui: {
2182
2153
  showTabHint: boolean;
2183
2154
  inputHasFocus: boolean;