@thoughtspot/visual-embed-sdk 1.45.2 → 1.45.3
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/cjs/package.json +1 -1
- package/cjs/src/css-variables.d.ts +48 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +37 -0
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +37 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +24 -0
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +127 -9
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +41 -18
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +96 -3
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +38 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +38 -10
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +179 -7
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +1 -0
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +1 -0
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/index.d.ts +3 -3
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/types.d.ts +192 -40
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +184 -19
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +23 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +9 -1
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +73 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils.d.ts +15 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +33 -1
- package/cjs/src/utils.js.map +1 -1
- package/cjs/src/utils.spec.js +49 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/{index-BdkKLLo1.js → index-BuwECGdm.js} +1 -1
- package/dist/src/css-variables.d.ts +48 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +37 -0
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +127 -9
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +38 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/errors.d.ts +1 -0
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts +3 -3
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +192 -40
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils.d.ts +15 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +364 -52
- package/dist/tsembed-react.js +363 -51
- package/dist/tsembed.es.js +364 -52
- package/dist/tsembed.js +363 -51
- package/dist/visual-embed-sdk-react-full.d.ts +696 -342
- package/dist/visual-embed-sdk-react.d.ts +685 -331
- package/dist/visual-embed-sdk.d.ts +757 -379
- package/lib/package.json +1 -1
- package/lib/src/css-variables.d.ts +48 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +37 -0
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +39 -3
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +24 -0
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +127 -9
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +42 -19
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +96 -3
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +38 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +39 -11
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +179 -7
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/errors.d.ts +1 -0
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +1 -0
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts +3 -3
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js.map +1 -1
- package/lib/src/types.d.ts +192 -40
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +184 -19
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +22 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +9 -1
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +73 -0
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils.d.ts +15 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +30 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/utils.spec.js +50 -1
- package/lib/src/utils.spec.js.map +1 -1
- package/package.json +1 -1
- package/src/css-variables.ts +60 -0
- package/src/embed/app.spec.ts +32 -0
- package/src/embed/app.ts +97 -1
- package/src/embed/conversation.spec.ts +117 -3
- package/src/embed/conversation.ts +188 -29
- package/src/embed/liveboard.spec.ts +264 -10
- package/src/embed/liveboard.ts +100 -11
- package/src/errors.ts +1 -0
- package/src/index.ts +5 -1
- package/src/types.ts +193 -40
- package/src/utils/graphql/answerService/answer-queries.ts +23 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +87 -0
- package/src/utils/graphql/answerService/answerService.ts +13 -1
- package/src/utils.spec.ts +56 -0
- package/src/utils.ts +36 -0
|
@@ -9,6 +9,104 @@ export interface SearchOptions {
|
|
|
9
9
|
*/
|
|
10
10
|
searchQuery: string;
|
|
11
11
|
}
|
|
12
|
+
/**
|
|
13
|
+
* Configuration for the Spotter sidebar.
|
|
14
|
+
* Can be used in SpotterEmbed and AppEmbed.
|
|
15
|
+
* @group Embed components
|
|
16
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
17
|
+
*/
|
|
18
|
+
export interface SpotterSidebarViewConfig {
|
|
19
|
+
/**
|
|
20
|
+
* Controls the visibility of the past conversations sidebar.
|
|
21
|
+
* @default false
|
|
22
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
23
|
+
*/
|
|
24
|
+
enablePastConversationsSidebar?: boolean;
|
|
25
|
+
/**
|
|
26
|
+
* Custom title text for the sidebar header.
|
|
27
|
+
* Defaults to translated "Spotter" text.
|
|
28
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
29
|
+
*/
|
|
30
|
+
spotterSidebarTitle?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Boolean to set the default expanded state of the sidebar.
|
|
33
|
+
* @default false
|
|
34
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
35
|
+
*/
|
|
36
|
+
spotterSidebarDefaultExpanded?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* Custom label text for the rename action in the conversation edit menu.
|
|
39
|
+
* Defaults to translated "Rename" text.
|
|
40
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
41
|
+
*/
|
|
42
|
+
spotterChatRenameLabel?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Custom label text for the delete action in the conversation edit menu.
|
|
45
|
+
* Defaults to translated "DELETE" text.
|
|
46
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
47
|
+
*/
|
|
48
|
+
spotterChatDeleteLabel?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Custom title text for the delete conversation confirmation modal.
|
|
51
|
+
* Defaults to translated "Delete chat" text.
|
|
52
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
53
|
+
*/
|
|
54
|
+
spotterDeleteConversationModalTitle?: string;
|
|
55
|
+
/**
|
|
56
|
+
* Custom message text for the past conversation banner alert.
|
|
57
|
+
* Defaults to translated alert message.
|
|
58
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
59
|
+
*/
|
|
60
|
+
spotterPastConversationAlertMessage?: string;
|
|
61
|
+
/**
|
|
62
|
+
* Custom URL for the documentation/best practices link.
|
|
63
|
+
* Defaults to ThoughtSpot docs URL based on release version.
|
|
64
|
+
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
65
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
66
|
+
*/
|
|
67
|
+
spotterDocumentationUrl?: string;
|
|
68
|
+
/**
|
|
69
|
+
* Custom label text for the best practices button in the footer.
|
|
70
|
+
* Defaults to translated "Best Practices" text.
|
|
71
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
72
|
+
*/
|
|
73
|
+
spotterBestPracticesLabel?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Number of conversations to fetch per batch when loading conversation history.
|
|
76
|
+
* @default 30
|
|
77
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
78
|
+
*/
|
|
79
|
+
spotterConversationsBatchSize?: number;
|
|
80
|
+
/**
|
|
81
|
+
* Custom title text for the "New Chat" button in the sidebar.
|
|
82
|
+
* Defaults to translated "New Chat" text.
|
|
83
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
84
|
+
*/
|
|
85
|
+
spotterNewChatButtonTitle?: string;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Configuration for customizing Spotter chat UI branding.
|
|
89
|
+
* @group Embed components
|
|
90
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
91
|
+
*/
|
|
92
|
+
export interface SpotterChatViewConfig {
|
|
93
|
+
/**
|
|
94
|
+
* Hides the ThoughtSpot logo/icon in tool response
|
|
95
|
+
* cards. The branding label prefix is controlled
|
|
96
|
+
* separately via `toolResponseCardBrandingLabel`.
|
|
97
|
+
* External MCP tool branding is not affected.
|
|
98
|
+
* @default false
|
|
99
|
+
*/
|
|
100
|
+
hideToolResponseCardBranding?: boolean;
|
|
101
|
+
/**
|
|
102
|
+
* Custom label to replace the "ThoughtSpot" prefix
|
|
103
|
+
* in tool response cards. Set to an empty string
|
|
104
|
+
* `''` to hide the prefix entirely. Works
|
|
105
|
+
* independently of `hideToolResponseCardBranding`.
|
|
106
|
+
* External MCP tool branding is not affected.
|
|
107
|
+
*/
|
|
108
|
+
toolResponseCardBrandingLabel?: string;
|
|
109
|
+
}
|
|
12
110
|
/**
|
|
13
111
|
* The configuration for the embedded spotterEmbed options.
|
|
14
112
|
* @group Embed components
|
|
@@ -164,8 +262,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
164
262
|
*/
|
|
165
263
|
excludeRuntimeParametersfromURL?: boolean;
|
|
166
264
|
/**
|
|
167
|
-
*
|
|
168
|
-
* sidebar.
|
|
265
|
+
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
169
266
|
*
|
|
170
267
|
* Supported embed types: `SpotterEmbed`
|
|
171
268
|
* @default false
|
|
@@ -173,27 +270,48 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
173
270
|
* ```js
|
|
174
271
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
175
272
|
* ... //other embed view config
|
|
176
|
-
*
|
|
273
|
+
* updatedSpotterChatPrompt : true,
|
|
177
274
|
* })
|
|
178
275
|
* ```
|
|
179
276
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
180
277
|
*/
|
|
181
|
-
|
|
278
|
+
updatedSpotterChatPrompt?: boolean;
|
|
182
279
|
/**
|
|
183
|
-
*
|
|
280
|
+
* Configuration for the Spotter sidebar UI customization.
|
|
281
|
+
*
|
|
282
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
283
|
+
* @example
|
|
284
|
+
* ```js
|
|
285
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
286
|
+
* ... //other embed view config
|
|
287
|
+
* spotterSidebarConfig: {
|
|
288
|
+
* enablePastConversationsSidebar: true,
|
|
289
|
+
* spotterSidebarTitle: 'My Conversations',
|
|
290
|
+
* spotterSidebarDefaultExpanded: true,
|
|
291
|
+
* },
|
|
292
|
+
* })
|
|
293
|
+
* ```
|
|
294
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
295
|
+
*/
|
|
296
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
297
|
+
/**
|
|
298
|
+
* Configuration for customizing Spotter chat UI
|
|
299
|
+
* branding in tool response cards.
|
|
184
300
|
*
|
|
185
301
|
* Supported embed types: `SpotterEmbed`
|
|
186
|
-
* @default false
|
|
187
302
|
* @example
|
|
188
303
|
* ```js
|
|
189
304
|
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
190
305
|
* ... //other embed view config
|
|
191
|
-
*
|
|
306
|
+
* spotterChatConfig: {
|
|
307
|
+
* hideToolResponseCardBranding: true,
|
|
308
|
+
* toolResponseCardBrandingLabel: 'MyBrand',
|
|
309
|
+
* },
|
|
192
310
|
* })
|
|
193
311
|
* ```
|
|
194
|
-
* @version SDK: 1.
|
|
312
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
195
313
|
*/
|
|
196
|
-
|
|
314
|
+
spotterChatConfig?: SpotterChatViewConfig;
|
|
197
315
|
}
|
|
198
316
|
/**
|
|
199
317
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation.d.ts","sourceRoot":"","sources":["conversation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,cAAc,EAAE,aAAa,EAAE,gBAAgB,EAAsC,MAAM,UAAU,CAAC;AACtH,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC;IACjF;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;;;OAcG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC;;;;;;;;;;OAUG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC;;;;;;;;;;OAUG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C
|
|
1
|
+
{"version":3,"file":"conversation.d.ts","sourceRoot":"","sources":["conversation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,cAAc,EAAE,aAAa,EAAE,gBAAgB,EAAsC,MAAM,UAAU,CAAC;AACtH,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C;;;;OAIG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;;;OAMG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;OAMG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC;IACjF;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;;;OAcG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC;;;;;;;;;;OAUG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC;;;;;;;;;;OAUG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;IAChD;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;CAC7C;AAED;;;;;GAKG;AAEH,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;CAAG;AAEzE;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAa,SAAQ,OAAO;IACD,SAAS,CAAC,UAAU,EAAE,sBAAsB;gBAApE,SAAS,EAAE,WAAW,EAAY,UAAU,EAAE,sBAAsB;IAUhF,SAAS,CAAC,oBAAoB;IA4FvB,YAAY,IAAI,MAAM;IAyChB,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC;CAO/C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACX,SAAS,CAAC,UAAU,EAAE,sBAAsB;gBAApE,SAAS,EAAE,WAAW,EAAY,UAAU,EAAE,sBAAsB;CASnF"}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
import { DOMSelector, HostEvent, SearchLiveboardCommonViewConfig as LiveboardOtherViewConfig, BaseViewConfig, LiveboardAppEmbedViewConfig, ContextType } from '../types';
|
|
11
11
|
import { TsEmbed, V1Embed } from './ts-embed';
|
|
12
12
|
import { TriggerPayload, TriggerResponse } from './hostEventClient/contracts';
|
|
13
|
+
import { SpotterChatViewConfig } from './conversation';
|
|
13
14
|
/**
|
|
14
15
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
15
16
|
* @group Embed components
|
|
@@ -187,6 +188,23 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
187
188
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
188
189
|
*/
|
|
189
190
|
activeTabId?: string;
|
|
191
|
+
/**
|
|
192
|
+
* The GUID of a saved personalized view to load.
|
|
193
|
+
* A personalized view is a saved configuration of a Liveboard
|
|
194
|
+
* that includes specific filter selections.
|
|
195
|
+
*
|
|
196
|
+
* Supported embed types: `LiveboardEmbed`
|
|
197
|
+
* @example
|
|
198
|
+
* ```js
|
|
199
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
200
|
+
* liveboardId: 'liveboard-guid',
|
|
201
|
+
* personalizedViewId: 'view-guid',
|
|
202
|
+
* activeTabId: 'tab-guid',
|
|
203
|
+
* })
|
|
204
|
+
* ```
|
|
205
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
206
|
+
*/
|
|
207
|
+
personalizedViewId?: string;
|
|
190
208
|
/**
|
|
191
209
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
192
210
|
*
|
|
@@ -440,6 +458,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
440
458
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
441
459
|
*/
|
|
442
460
|
updatedSpotterChatPrompt?: boolean;
|
|
461
|
+
/**
|
|
462
|
+
* Configuration for customizing Spotter chat UI
|
|
463
|
+
* branding in tool response cards.
|
|
464
|
+
*
|
|
465
|
+
* Supported embed types: `LiveboardEmbed`
|
|
466
|
+
* @example
|
|
467
|
+
* ```js
|
|
468
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
469
|
+
* ... //other embed view config
|
|
470
|
+
* spotterChatConfig: {
|
|
471
|
+
* hideToolResponseCardBranding: true,
|
|
472
|
+
* toolResponseCardBrandingLabel: 'MyBrand',
|
|
473
|
+
* },
|
|
474
|
+
* })
|
|
475
|
+
* ```
|
|
476
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
477
|
+
*/
|
|
478
|
+
spotterChatConfig?: SpotterChatViewConfig;
|
|
443
479
|
}
|
|
444
480
|
/**
|
|
445
481
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -499,6 +535,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
499
535
|
liveboardId: string;
|
|
500
536
|
vizId: string;
|
|
501
537
|
activeTabId: string;
|
|
538
|
+
personalizedViewId: string;
|
|
502
539
|
};
|
|
503
540
|
protected beforePrerenderVisible(): void;
|
|
504
541
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
@@ -523,7 +560,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
523
560
|
* visualization ID and the runtime filters.
|
|
524
561
|
*/
|
|
525
562
|
render(): Promise<LiveboardEmbed>;
|
|
526
|
-
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
563
|
+
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, personalizedViewId?: string): void;
|
|
527
564
|
/**
|
|
528
565
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
529
566
|
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,+BAA+B,IAAI,wBAAwB,EAC3D,cAAc,EACd,2BAA2B,EAG3B,WAAW,EACd,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;
|
|
1
|
+
{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,+BAA+B,IAAI,wBAAwB,EAC3D,cAAc,EACd,2BAA2B,EAG3B,WAAW,EACd,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAGvD;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,cAAc,EAAE,wBAAwB,EAAE,2BAA2B;IAC9G;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;;OAaG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;;;;;;;;OAcG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;;;;;;;;;;;;OAcG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;;;;;;;;;OAcG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAC5C;;;;;;;;;;;;;;OAcG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAC5C;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;;;;;;;;;;OAcG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;CAC7C;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IAgBrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAMxB,SAAS,CAAC,oBAAoB;IAyK9B,OAAO,CAAC,kBAAkB;IAqC1B,OAAO,CAAC,0BAA0B,CAGhC;IAEF;;;;;OAKG;IACH,OAAO,CAAC,qCAAqC,CAI5C;IAED;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAGxB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAqBzC;IAEF,OAAO,CAAC,YAAY;YAQN,iBAAiB;IAkC/B;;;;OAIG;IACI,qBAAqB;;;;;MAK1B;IAEF,SAAS,CAAC,sBAAsB,IAAI,IAAI;cAqBxB,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC;IAO5D;;;;;OAKG;IACI,OAAO,CAAC,UAAU,SAAS,SAAS,EAAE,QAAQ,EAAE,QAAQ,SAAS,WAAW,EAC/E,WAAW,EAAE,UAAU,EACvB,IAAI,GAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAe,EACxD,OAAO,CAAC,EAAE,QAAQ,GACnB,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAW3D;;;OAGG;IACI,OAAO;IAKd,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,sBAAsB;IAQ9B,OAAO,CAAC,wBAAwB;IAOhC;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;IAWvC,mBAAmB,CACtB,WAAW,EAAE,MAAM,EACnB,KAAK,CAAC,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,MAAM,EACpB,kBAAkB,CAAC,EAAE,MAAM;IAgB/B;;;;OAIG;IACI,eAAe,IAAI,MAAM;CAgBnC;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAI"}
|
package/dist/src/errors.d.ts
CHANGED
|
@@ -29,6 +29,7 @@ export declare const ERROR_MESSAGE: {
|
|
|
29
29
|
ERROR_PARSING_API_INTERCEPT_BODY: string;
|
|
30
30
|
SSR_ENVIRONMENT_ERROR: string;
|
|
31
31
|
UPDATE_PARAMS_FAILED: string;
|
|
32
|
+
INVALID_SPOTTER_DOCUMENTATION_URL: string;
|
|
32
33
|
};
|
|
33
34
|
export declare const CUSTOM_ACTIONS_ERROR_MESSAGE: {
|
|
34
35
|
INVALID_ACTION_OBJECT: string;
|
package/dist/src/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["errors.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["errors.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCzB,CAAC;AAEF,eAAO,MAAM,4BAA4B;;kCAEP,MAAM,iBAAiB,MAAM,EAAE;6BACpC,MAAM,cAAc,MAAM;iCACtB,MAAM,cAAc,MAAM,sBAAsB,MAAM;uCAChD,MAAM,cAAc,MAAM,EAAE,gBAAgB,MAAM;yCAChD,MAAM,cAAc,MAAM,EAAE,gBAAgB,MAAM;iCAC1D,MAAM,iBAAiB,MAAM,EAAE,mBAAmB,MAAM;wBACjE,MAAM,kBAAkB,MAAM,EAAE,YAAY,MAAM;CACzE,CAAC"}
|
package/dist/src/index.d.ts
CHANGED
|
@@ -12,10 +12,10 @@ import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from './embed/live
|
|
|
12
12
|
import { SearchEmbed, SearchViewConfig } from './embed/search';
|
|
13
13
|
import { SearchBarEmbed, SearchBarViewConfig } from './embed/search-bar';
|
|
14
14
|
import { SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversation, BodylessConversationViewConfig } from './embed/bodyless-conversation';
|
|
15
|
-
import { SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed, ConversationViewConfig } from './embed/conversation';
|
|
15
|
+
import { SpotterEmbed, SpotterEmbedViewConfig, SpotterChatViewConfig, SpotterSidebarViewConfig, ConversationEmbed, ConversationViewConfig } from './embed/conversation';
|
|
16
16
|
import { AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter } from './auth';
|
|
17
17
|
import { getSessionInfo } from './utils/sessionInfoService';
|
|
18
|
-
import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures, FrameParams, DOMSelector, HomeLeftNavItem, HomepageModule, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, ContextMenuTriggerOptions, RuntimeParameter, LogLevel, VizPoint, CustomActionPayload, ListPageColumns, CustomActionsPosition, CustomActionTarget, InterceptedApiType, EmbedErrorCodes, ErrorDetailsTypes, ContextType } from './types';
|
|
18
|
+
import { AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, EmbedConfig, PrefetchFeatures, FrameParams, DOMSelector, HomeLeftNavItem, HomepageModule, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, ContextMenuTriggerOptions, RuntimeParameter, LogLevel, VizPoint, CustomActionPayload, ListPageColumns, CustomActionsPosition, CustomActionTarget, InterceptedApiType, EmbedErrorCodes, EmbedErrorDetailsEvent, ErrorDetailsTypes, ContextType } from './types';
|
|
19
19
|
import { CustomCssVariables } from './css-variables';
|
|
20
20
|
import { SageEmbed, SageViewConfig } from './embed/sage';
|
|
21
21
|
import { AnswerService, SessionInterface, UnderlyingDataPoint } from './utils/graphql/answerService/answerService';
|
|
@@ -25,6 +25,6 @@ import { tokenizedFetch } from './tokenizedFetch';
|
|
|
25
25
|
import { getAnswerFromQuery } from './utils/graphql/nlsService/nls-answer-service';
|
|
26
26
|
import { createLiveboardWithAnswers } from './utils/liveboardService/liveboardService';
|
|
27
27
|
import { UIPassthroughEvent } from './embed/hostEventClient/contracts';
|
|
28
|
-
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, reloadIframe, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, ContextType, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, CustomActionsPosition, CustomActionTarget, InterceptedApiType, EmbedErrorCodes, ErrorDetailsTypes, };
|
|
28
|
+
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, reloadIframe, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, SpotterChatViewConfig, SpotterSidebarViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, ContextType, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, CustomActionsPosition, CustomActionTarget, InterceptedApiType, EmbedErrorCodes, EmbedErrorDetailsEvent, ErrorDetailsTypes, };
|
|
29
29
|
export { resetCachedAuthToken } from './authToken';
|
|
30
30
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/src/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,OAAO,EACH,QAAQ,EACR,IAAI,EACJ,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,QAAQ,EACR,QAAQ,EACR,yCAAyC,EAC5C,MAAM,aAAa,CAAC;AACrB,OAAO,EACH,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,UAAU,EACV,SAAS,EACT,eAAe,EACf,cAAc,EACd,YAAY,EACf,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,2BAA2B,EAAE,oBAAoB,EAAE,8BAA8B,EAAC,MAAM,+BAA+B,CAAC;AACpJ,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,OAAO,EACH,QAAQ,EACR,IAAI,EACJ,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,QAAQ,EACR,QAAQ,EACR,yCAAyC,EAC5C,MAAM,aAAa,CAAC;AACrB,OAAO,EACH,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,UAAU,EACV,SAAS,EACT,eAAe,EACf,cAAc,EACd,YAAY,EACf,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,2BAA2B,EAAE,oBAAoB,EAAE,8BAA8B,EAAC,MAAM,+BAA+B,CAAC;AACpJ,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AACxK,OAAO,EACH,eAAe,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAC3D,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EACH,QAAQ,EACR,aAAa,EACb,eAAe,EACf,UAAU,EACV,SAAS,EACT,oBAAoB,EACpB,MAAM,EACN,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,eAAe,EACf,cAAc,EACd,cAAc,EACd,eAAe,EACf,cAAc,EACd,uBAAuB,EACvB,YAAY,EACZ,kBAAkB,EAClB,yBAAyB,EACzB,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,WAAW,EACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAC;AACnH,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAAE,0BAA0B,EAAE,MAAM,2CAA2C,CAAC;AACvF,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAEvE,OAAO,EACH,IAAI,EACJ,MAAM,EACN,QAAQ,EACR,UAAU,EACV,SAAS,EACT,eAAe,EACf,YAAY,EACZ,cAAc,EACd,cAAc,IAAI,aAAa,EAC/B,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC1B,WAAW,EACX,cAAc,EACd,aAAa,EACb,cAAc,EACd,SAAS,EACT,QAAQ,EACR,iBAAiB,EACjB,2BAA2B,EAC3B,8BAA8B,EAC9B,oBAAoB,EACpB,YAAY,EACZ,sBAAsB,EACtB,qBAAqB,EACrB,wBAAwB,EACxB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,UAAU,EACV,SAAS,EACT,gBAAgB,EAChB,aAAa,EAEb,gBAAgB,EAChB,mBAAmB,EACnB,IAAI,EACJ,QAAQ,EACR,aAAa,EACb,eAAe,EACf,UAAU,EACV,SAAS,EACT,WAAW,EACX,oBAAoB,EACpB,MAAM,EACN,yBAAyB,EACzB,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,cAAc,EACd,WAAW,EACX,cAAc,EACd,eAAe,EACf,cAAc,EACd,uBAAuB,EACvB,YAAY,EACZ,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,QAAQ,EACR,mBAAmB,EACnB,cAAc,EACd,qBAAqB,EACrB,oBAAoB,EACpB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,yCAAyC,EACzC,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EACtB,iBAAiB,GACpB,CAAC;AAEF,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC"}
|
package/dist/src/types.d.ts
CHANGED
|
@@ -1559,7 +1559,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
1559
1559
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
1560
1560
|
*
|
|
1561
1561
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
1562
|
-
* @version SDK: 1.
|
|
1562
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
1563
1563
|
* @example
|
|
1564
1564
|
* ```js
|
|
1565
1565
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -3137,6 +3137,42 @@ export declare enum EmbedEvent {
|
|
|
3137
3137
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
3138
3138
|
*/
|
|
3139
3139
|
ApiIntercept = "ApiIntercept",
|
|
3140
|
+
/**
|
|
3141
|
+
* Emitted when a Spotter conversation is renamed.
|
|
3142
|
+
* @example
|
|
3143
|
+
* ```js
|
|
3144
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationRenamed, (payload) => {
|
|
3145
|
+
* console.log('Conversation renamed', payload);
|
|
3146
|
+
* // payload: { convId: string, oldTitle: string, newTitle: string }
|
|
3147
|
+
* })
|
|
3148
|
+
* ```
|
|
3149
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3150
|
+
*/
|
|
3151
|
+
SpotterConversationRenamed = "spotterConversationRenamed",
|
|
3152
|
+
/**
|
|
3153
|
+
* Emitted when a Spotter conversation is deleted.
|
|
3154
|
+
* @example
|
|
3155
|
+
* ```js
|
|
3156
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationDeleted, (payload) => {
|
|
3157
|
+
* console.log('Conversation deleted', payload);
|
|
3158
|
+
* // payload: { convId: string, title: string }
|
|
3159
|
+
* })
|
|
3160
|
+
* ```
|
|
3161
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3162
|
+
*/
|
|
3163
|
+
SpotterConversationDeleted = "spotterConversationDeleted",
|
|
3164
|
+
/**
|
|
3165
|
+
* Emitted when a Spotter conversation is selected/clicked.
|
|
3166
|
+
* @example
|
|
3167
|
+
* ```js
|
|
3168
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => {
|
|
3169
|
+
* console.log('Conversation selected', payload);
|
|
3170
|
+
* // payload: { convId: string, title: string, worksheetId: string }
|
|
3171
|
+
* })
|
|
3172
|
+
* ```
|
|
3173
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3174
|
+
*/
|
|
3175
|
+
SpotterConversationSelected = "spotterConversationSelected",
|
|
3140
3176
|
/**
|
|
3141
3177
|
* @hidden
|
|
3142
3178
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -4690,7 +4726,19 @@ export declare enum Param {
|
|
|
4690
4726
|
isLinkParametersEnabled = "isLinkParametersEnabled",
|
|
4691
4727
|
EnablePastConversationsSidebar = "enablePastConversationsSidebar",
|
|
4692
4728
|
UpdatedSpotterChatPrompt = "updatedSpotterChatPrompt",
|
|
4693
|
-
|
|
4729
|
+
SpotterSidebarTitle = "spotterSidebarTitle",
|
|
4730
|
+
SpotterSidebarDefaultExpanded = "spotterSidebarDefaultExpanded",
|
|
4731
|
+
SpotterChatRenameLabel = "spotterChatRenameLabel",
|
|
4732
|
+
SpotterChatDeleteLabel = "spotterChatDeleteLabel",
|
|
4733
|
+
SpotterDeleteConversationModalTitle = "spotterDeleteConversationModalTitle",
|
|
4734
|
+
SpotterPastConversationAlertMessage = "spotterPastConversationAlertMessage",
|
|
4735
|
+
SpotterDocumentationUrl = "spotterDocumentationUrl",
|
|
4736
|
+
SpotterBestPracticesLabel = "spotterBestPracticesLabel",
|
|
4737
|
+
SpotterConversationsBatchSize = "spotterConversationsBatchSize",
|
|
4738
|
+
SpotterNewChatButtonTitle = "spotterNewChatButtonTitle",
|
|
4739
|
+
IsThisPeriodInDateFiltersEnabled = "isThisPeriodInDateFiltersEnabled",
|
|
4740
|
+
HideToolResponseCardBranding = "hideToolResponseCardBranding",
|
|
4741
|
+
ToolResponseCardBrandingLabel = "toolResponseCardBrandingLabel"
|
|
4694
4742
|
}
|
|
4695
4743
|
/**
|
|
4696
4744
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -6115,6 +6163,96 @@ export declare enum Action {
|
|
|
6115
6163
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6116
6164
|
*/
|
|
6117
6165
|
UngroupLiveboardGroup = "ungroupLiveboardGroup",
|
|
6166
|
+
/**
|
|
6167
|
+
* Controls visibility of the sidebar header (title and toggle button)
|
|
6168
|
+
* in the Spotter past conversations sidebar.
|
|
6169
|
+
* @example
|
|
6170
|
+
* ```js
|
|
6171
|
+
* hiddenActions: [Action.SpotterSidebarHeader]
|
|
6172
|
+
* ```
|
|
6173
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6174
|
+
*/
|
|
6175
|
+
SpotterSidebarHeader = "spotterSidebarHeader",
|
|
6176
|
+
/**
|
|
6177
|
+
* Controls visibility of the sidebar footer (documentation link)
|
|
6178
|
+
* in the Spotter past conversations sidebar.
|
|
6179
|
+
* @example
|
|
6180
|
+
* ```js
|
|
6181
|
+
* hiddenActions: [Action.SpotterSidebarFooter]
|
|
6182
|
+
* ```
|
|
6183
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6184
|
+
*/
|
|
6185
|
+
SpotterSidebarFooter = "spotterSidebarFooter",
|
|
6186
|
+
/**
|
|
6187
|
+
* Controls visibility and disable state of the sidebar toggle/expand button
|
|
6188
|
+
* in the Spotter past conversations sidebar.
|
|
6189
|
+
* @example
|
|
6190
|
+
* ```js
|
|
6191
|
+
* disabledActions: [Action.SpotterSidebarToggle]
|
|
6192
|
+
* ```
|
|
6193
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6194
|
+
*/
|
|
6195
|
+
SpotterSidebarToggle = "spotterSidebarToggle",
|
|
6196
|
+
/**
|
|
6197
|
+
* Controls visibility and disable state of the "New Chat" button
|
|
6198
|
+
* in the Spotter past conversations sidebar.
|
|
6199
|
+
* @example
|
|
6200
|
+
* ```js
|
|
6201
|
+
* disabledActions: [Action.SpotterNewChat]
|
|
6202
|
+
* ```
|
|
6203
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6204
|
+
*/
|
|
6205
|
+
SpotterNewChat = "spotterNewChat",
|
|
6206
|
+
/**
|
|
6207
|
+
* Controls visibility of the past conversation banner alert
|
|
6208
|
+
* in the Spotter interface.
|
|
6209
|
+
* @example
|
|
6210
|
+
* ```js
|
|
6211
|
+
* hiddenActions: [Action.SpotterPastChatBanner]
|
|
6212
|
+
* ```
|
|
6213
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6214
|
+
*/
|
|
6215
|
+
SpotterPastChatBanner = "spotterPastChatBanner",
|
|
6216
|
+
/**
|
|
6217
|
+
* Controls visibility and disable state of the conversation edit menu
|
|
6218
|
+
* (three-dot menu) in the Spotter past conversations sidebar.
|
|
6219
|
+
* @example
|
|
6220
|
+
* ```js
|
|
6221
|
+
* disabledActions: [Action.SpotterChatMenu]
|
|
6222
|
+
* ```
|
|
6223
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6224
|
+
*/
|
|
6225
|
+
SpotterChatMenu = "spotterChatMenu",
|
|
6226
|
+
/**
|
|
6227
|
+
* Controls visibility and disable state of the rename action
|
|
6228
|
+
* in the Spotter conversation edit menu.
|
|
6229
|
+
* @example
|
|
6230
|
+
* ```js
|
|
6231
|
+
* disabledActions: [Action.SpotterChatRename]
|
|
6232
|
+
* ```
|
|
6233
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6234
|
+
*/
|
|
6235
|
+
SpotterChatRename = "spotterChatRename",
|
|
6236
|
+
/**
|
|
6237
|
+
* Controls visibility and disable state of the delete action
|
|
6238
|
+
* in the Spotter conversation edit menu.
|
|
6239
|
+
* @example
|
|
6240
|
+
* ```js
|
|
6241
|
+
* disabledActions: [Action.SpotterChatDelete]
|
|
6242
|
+
* ```
|
|
6243
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6244
|
+
*/
|
|
6245
|
+
SpotterChatDelete = "spotterChatDelete",
|
|
6246
|
+
/**
|
|
6247
|
+
* Controls visibility and disable state of the documentation/best practices
|
|
6248
|
+
* link in the Spotter sidebar footer.
|
|
6249
|
+
* @example
|
|
6250
|
+
* ```js
|
|
6251
|
+
* disabledActions: [Action.SpotterDocs]
|
|
6252
|
+
* ```
|
|
6253
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6254
|
+
*/
|
|
6255
|
+
SpotterDocs = "spotterDocs",
|
|
6118
6256
|
/**
|
|
6119
6257
|
* The **Include current period** checkbox for date filters.
|
|
6120
6258
|
* Controls the visibility and availability of the option to include
|
|
@@ -6309,13 +6447,30 @@ export declare enum LogLevel {
|
|
|
6309
6447
|
* Error types emitted by embedded components.
|
|
6310
6448
|
*
|
|
6311
6449
|
* These enum values categorize different types of errors that can occur during
|
|
6312
|
-
* the lifecycle of an embedded ThoughtSpot component.
|
|
6313
|
-
*
|
|
6314
|
-
*
|
|
6315
|
-
* @see {@link EmbedErrorDetailsEvent} - The error event object structure
|
|
6316
|
-
* @see {@link EmbedEvent.Error} - The event that emits these errors
|
|
6450
|
+
* the lifecycle of an embedded ThoughtSpot component.
|
|
6451
|
+
* Use {@link EmbedErrorDetailsEvent} and {@link EmbedErrorCodes} to handle specific errors.
|
|
6317
6452
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6318
6453
|
* @group Error Handling
|
|
6454
|
+
*
|
|
6455
|
+
* @example
|
|
6456
|
+
* Handle specific error types
|
|
6457
|
+
* ```js
|
|
6458
|
+
* embed.on(EmbedEvent.Error, (error) => {
|
|
6459
|
+
* switch (error.errorType) {
|
|
6460
|
+
* case ErrorDetailsTypes.API:
|
|
6461
|
+
* console.error('API error:', error.message);
|
|
6462
|
+
* break;
|
|
6463
|
+
* case ErrorDetailsTypes.VALIDATION_ERROR:
|
|
6464
|
+
* console.error('Validation error:', error.message);
|
|
6465
|
+
* break;
|
|
6466
|
+
* case ErrorDetailsTypes.NETWORK:
|
|
6467
|
+
* console.error('Network error:', error.message);
|
|
6468
|
+
* break;
|
|
6469
|
+
* default:
|
|
6470
|
+
* console.error('Unknown error:', error);
|
|
6471
|
+
* }
|
|
6472
|
+
* });
|
|
6473
|
+
* ```
|
|
6319
6474
|
*/
|
|
6320
6475
|
export declare enum ErrorDetailsTypes {
|
|
6321
6476
|
/** API call failure */
|
|
@@ -6326,34 +6481,42 @@ export declare enum ErrorDetailsTypes {
|
|
|
6326
6481
|
NETWORK = "NETWORK"
|
|
6327
6482
|
}
|
|
6328
6483
|
/**
|
|
6329
|
-
* Error codes for identifying specific issues in embedded ThoughtSpot components.
|
|
6330
|
-
*
|
|
6331
|
-
* Use these codes for precise error handling and debugging. Each code maps to a
|
|
6332
|
-
* distinct failure scenario, enabling targeted recovery strategies.
|
|
6484
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components. Use {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error handling and debugging.
|
|
6333
6485
|
*
|
|
6334
6486
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6335
6487
|
* @group Error Handling
|
|
6336
|
-
|
|
6337
|
-
* @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
|
|
6338
|
-
* @see {@link ErrorDetailsTypes} - General error type categories
|
|
6339
|
-
*
|
|
6488
|
+
|
|
6340
6489
|
* @example
|
|
6341
6490
|
* Handle specific error codes in the error event handler
|
|
6342
|
-
*
|
|
6491
|
+
* ```js
|
|
6343
6492
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6344
|
-
*
|
|
6345
|
-
*
|
|
6493
|
+
* switch (error.code) {
|
|
6494
|
+
* case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
|
|
6495
|
+
* console.error('Worksheet ID not found:', error.message);
|
|
6496
|
+
* break;
|
|
6497
|
+
* case EmbedErrorCodes.LIVEBOARD_ID_MISSING:
|
|
6498
|
+
* console.error('Liveboard ID is missing:', error.message);
|
|
6499
|
+
* break;
|
|
6500
|
+
* case EmbedErrorCodes.CONFLICTING_ACTIONS_CONFIG:
|
|
6501
|
+
* console.error('Conflicting actions configuration:', error.message);
|
|
6502
|
+
* break;
|
|
6503
|
+
* case EmbedErrorCodes.CONFLICTING_TABS_CONFIG:
|
|
6504
|
+
* console.error('Conflicting tabs configuration:', error.message);
|
|
6505
|
+
* break;
|
|
6506
|
+
* default:
|
|
6507
|
+
* console.error('Unknown error:', error);
|
|
6346
6508
|
* }
|
|
6347
6509
|
* });
|
|
6348
|
-
*
|
|
6510
|
+
* ```
|
|
6511
|
+
* */
|
|
6349
6512
|
export declare enum EmbedErrorCodes {
|
|
6350
6513
|
/** Worksheet ID not found or does not exist */
|
|
6351
6514
|
WORKSHEET_ID_NOT_FOUND = "WORKSHEET_ID_NOT_FOUND",
|
|
6352
6515
|
/** Required Liveboard ID is missing from configuration */
|
|
6353
6516
|
LIVEBOARD_ID_MISSING = "LIVEBOARD_ID_MISSING",
|
|
6354
|
-
/** Conflicting action configuration detected
|
|
6517
|
+
/** Conflicting action configuration detected */
|
|
6355
6518
|
CONFLICTING_ACTIONS_CONFIG = "CONFLICTING_ACTIONS_CONFIG",
|
|
6356
|
-
/** Conflicting tab configuration detected
|
|
6519
|
+
/** Conflicting tab configuration detected */
|
|
6357
6520
|
CONFLICTING_TABS_CONFIG = "CONFLICTING_TABS_CONFIG",
|
|
6358
6521
|
/** Error during component initialization */
|
|
6359
6522
|
INIT_ERROR = "INIT_ERROR",
|
|
@@ -6370,7 +6533,9 @@ export declare enum EmbedErrorCodes {
|
|
|
6370
6533
|
/** Error parsing api intercept body */
|
|
6371
6534
|
PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
|
|
6372
6535
|
/** Failed to update embed parameters during pre-render */
|
|
6373
|
-
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
|
|
6536
|
+
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
|
|
6537
|
+
/** Invalid URL provided in configuration */
|
|
6538
|
+
INVALID_URL = "INVALID_URL"
|
|
6374
6539
|
}
|
|
6375
6540
|
/**
|
|
6376
6541
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -6383,7 +6548,7 @@ export declare enum EmbedErrorCodes {
|
|
|
6383
6548
|
*
|
|
6384
6549
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
6385
6550
|
* - **message**: Human-readable error description (string or array of strings for multiple errors)
|
|
6386
|
-
* - **code**: Machine-readable error identifier
|
|
6551
|
+
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes} values
|
|
6387
6552
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
6388
6553
|
*
|
|
6389
6554
|
* ## Usage
|
|
@@ -6393,12 +6558,11 @@ export declare enum EmbedErrorCodes {
|
|
|
6393
6558
|
*
|
|
6394
6559
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6395
6560
|
* @group Error Handling
|
|
6396
|
-
* @see {@link ErrorDetailsTypes} - Available error type values
|
|
6397
|
-
* @see {@link EmbedEvent.Error} - The event that emits this object
|
|
6398
6561
|
*
|
|
6399
6562
|
* @example
|
|
6400
6563
|
* Handle specific error types
|
|
6401
6564
|
*
|
|
6565
|
+
* ```js
|
|
6402
6566
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6403
6567
|
* switch (error.code) {
|
|
6404
6568
|
* case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
|
|
@@ -6408,30 +6572,18 @@ export declare enum EmbedErrorCodes {
|
|
|
6408
6572
|
* console.error('Unknown error:', error);
|
|
6409
6573
|
* }
|
|
6410
6574
|
* });
|
|
6411
|
-
*
|
|
6575
|
+
* ```
|
|
6412
6576
|
* @example
|
|
6413
6577
|
* Handle multiple error messages
|
|
6414
6578
|
*
|
|
6579
|
+
* ```js
|
|
6415
6580
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6416
6581
|
* const messages = Array.isArray(error.message)
|
|
6417
6582
|
* ? error.message
|
|
6418
6583
|
* : [error.message];
|
|
6419
|
-
*
|
|
6420
6584
|
* messages.forEach(msg => console.error(msg));
|
|
6421
6585
|
* });
|
|
6422
|
-
*
|
|
6423
|
-
* @example
|
|
6424
|
-
* Access additional error context
|
|
6425
|
-
*
|
|
6426
|
-
* embed.on(EmbedEvent.Error, (error) => {
|
|
6427
|
-
* console.error('Error Details:', {
|
|
6428
|
-
* type: error.errorType,
|
|
6429
|
-
* message: error.message,
|
|
6430
|
-
* code: error.code,
|
|
6431
|
-
* // Additional context fields vary by error type
|
|
6432
|
-
* ...error
|
|
6433
|
-
* });
|
|
6434
|
-
* });
|
|
6586
|
+
* ```
|
|
6435
6587
|
* */
|
|
6436
6588
|
export interface EmbedErrorDetailsEvent {
|
|
6437
6589
|
/** The type of error that occurred */
|